com.stimulsoft.webviewer
Class StiWebViewerOptions

java.lang.Object
  extended by com.stimulsoft.webviewer.StiWebViewerOptions
All Implemented Interfaces:
java.io.Serializable

public class StiWebViewerOptions
extends java.lang.Object
implements java.io.Serializable

Copyright Stimulsoft

See Also:
Serialized Form

Nested Class Summary
 class StiWebViewerOptions.AppearanceOptions
           
 class StiWebViewerOptions.EmailOptions
           
 class StiWebViewerOptions.ExportOptions
           
 class StiWebViewerOptions.ServerOptions
           
 class StiWebViewerOptions.ToolbarOptions
           
 
Constructor Summary
StiWebViewerOptions()
           
 
Method Summary
 JSONObject getActions()
           
 StiWebViewerOptions.AppearanceOptions getAppearance()
          A class which controls settings of the viewer appearance.
 StiColor getBackColor()
          Deprecated. 
 int getBookmarksTreeWidth()
          Deprecated. 
 int getCountColumnsParameters()
          Deprecated. 
 java.lang.String getDefaultEmailAdress()
          Deprecated. 
 java.lang.String getDefaultEmailMessage()
          Deprecated. 
 java.lang.String getDefaultEmailSubject()
          Deprecated. 
 java.util.Collection<StiExportSettings> getDefaultExportSettings()
          An array of export settings that will be used by default.
 StiWebViewerOptions.EmailOptions getEmail()
          A class which controls the email options.
 StiWebViewerExceptionHandler getExceptionHandler()
          StiWebViewerExceptionHandler Calls on exception while WebDesigner process.
 StiWebViewerOptions.ExportOptions getExports()
          A class which controls the export options.
 java.lang.String getHeight()
           
 java.lang.String getJsObject()
           
 java.lang.String getLocalization()
          A path to the localization file for the web viewer.
 java.io.InputStream getLocalizationStream()
           
 StiPrintDestination getMenuPrintDestination()
          Deprecated. 
 StiShowMenuMode getMenuShowMode()
          Deprecated. 
 int getMenuZoom()
          Deprecated. 
 java.lang.String getOpenExportedReportTarget()
          Deprecated. 
 java.lang.String getOpenLinksTarget()
          Deprecated. 
 StiContentAlignment getPageAlignment()
          Deprecated. 
 StiColor getPageBorderColor()
          Deprecated. 
 StiWebViewMode getPagesViewMode()
          Deprecated. 
 int getRefreshTimeout()
          A value wich indicates timeout in minutes for execute dummy request to avoid end session
 java.lang.Integer getRequestTimeout()
          Timeout AJAX requests in seconds
 StiWebViewerOptions.ServerOptions getServer()
          A class which controls the server options.
 StiWebViewerTheme getTheme()
          The current visual theme which is used for drawing visual elements of the webviewer.
 StiWebViewerOptions.ToolbarOptions getToolbar()
          A class which controls settings of the viewer toolbar.
 StiContentAlignment getToolbarAlignment()
          Deprecated. 
 StiColor getToolbarBackgroundColor()
          Deprecated. 
 StiColor getToolbarFontColor()
          Deprecated. 
 java.lang.String getToolbarFontFamily()
          Deprecated. 
 java.lang.String getViewerID()
           
 java.lang.String getWidth()
           
 boolean isBookmarksPrint()
          Deprecated. 
 boolean isBookmarksVisible()
          Deprecated. 
 boolean isMenuAnimation()
          Deprecated. 
 boolean isPageShowShadow()
          Deprecated. 
 boolean isRightToLeft()
          Deprecated. 
 boolean isScrollbarsMode()
          Deprecated. 
 boolean isServerCacheAsObject()
          The mode that caches the report as object.
 boolean isShowAboutButton()
          Deprecated. 
 boolean isShowButtonBookmarks()
          Deprecated. 
 boolean isShowButtonDesign()
          Deprecated. 
 boolean isShowButtonFirstPage()
          Deprecated. 
 boolean isShowButtonLastPage()
          Deprecated. 
 boolean isShowButtonNextPage()
          Deprecated. 
 boolean isShowButtonParameters()
          Deprecated. 
 boolean isShowButtonPreviousPage()
          Deprecated. 
 boolean isShowButtonPrint()
          Deprecated. 
 boolean isShowButtonSave()
          Deprecated. 
 boolean isShowButtonSendEmail()
          Deprecated. 
 boolean isShowButtonViewMode()
          Deprecated. 
 boolean isShowButtonZoom()
          Deprecated. 
 boolean isShowCurrentPageControl()
          Deprecated. 
 boolean isShowEmailDialog()
          Deprecated. 
 boolean isShowExportDialog()
          Deprecated. 
 boolean isShowExportToCsv()
          Deprecated. 
 boolean isShowExportToDbf()
          Deprecated. 
 boolean isShowExportToDif()
          Deprecated. 
 boolean isShowExportToDocument()
          Deprecated. 
 boolean isShowExportToExcel()
          Deprecated. 
 boolean isShowExportToExcel2007()
          Deprecated. 
 boolean isShowExportToExcelXml()
          Deprecated. 
 boolean isShowExportToHtml()
          Deprecated. 
 boolean isShowExportToHtml5()
          Deprecated. 
 boolean isShowExportToImageBmp()
          Deprecated. 
 boolean isShowExportToImageGif()
          Deprecated. 
 boolean isShowExportToImageJpeg()
          Deprecated. 
 boolean isShowExportToImageMetafile()
          Deprecated. 
 boolean isShowExportToImagePcx()
          Deprecated. 
 boolean isShowExportToImagePng()
          Deprecated. 
 boolean isShowExportToImageSvg()
          Deprecated. 
 boolean isShowExportToImageSvgz()
          Deprecated. 
 boolean isShowExportToImageTiff()
          Deprecated. 
 boolean isShowExportToMht()
          Deprecated. 
 boolean isShowExportToOpenDocumentCalc()
          Deprecated. 
 boolean isShowExportToOpenDocumentWriter()
          Deprecated. 
 boolean isShowExportToPdf()
          Deprecated. 
 boolean isShowExportToPowerPoint()
           
 boolean isShowExportToRtf()
          Deprecated. 
 boolean isShowExportToSylk()
          Deprecated. 
 boolean isShowExportToText()
          Deprecated. 
 boolean isShowExportToWord2007()
          Deprecated. 
 boolean isShowExportToXml()
          Deprecated. 
 boolean isShowExportToXps()
          Deprecated. 
 boolean isShowTooltips()
          Deprecated. 
 boolean isToolbarButtonCaptions()
          Deprecated. 
 boolean isToolbarMenuCaptions()
          Deprecated. 
 boolean isToolbarVisible()
          Deprecated. 
 void setAppearance(StiWebViewerOptions.AppearanceOptions appearance)
          A class which controls settings of the viewer appearance.
 void setBackColor(StiColor backColor)
          Deprecated. 
 void setBookmarksPrint(boolean bookmarksPrint)
          Deprecated. 
 void setBookmarksTreeWidth(int bookmarksTreeWidth)
          Deprecated. 
 void setBookmarksVisible(boolean bookmarksVisible)
          Deprecated. 
 void setCountColumnsParameters(int countColumnsParameters)
          Deprecated. 
 void setDefaultEmailAdress(java.lang.String defaultEmailAdress)
          Deprecated. 
 void setDefaultEmailMessage(java.lang.String defaultEmailMessage)
          Deprecated. 
 void setDefaultEmailSubject(java.lang.String defaultEmailSubject)
          Deprecated. 
 void setDefaultExportSettings(java.util.Collection<StiExportSettings> defaultExportSettings)
          An array of export settings that will be used by default.
 void setEmail(StiWebViewerOptions.EmailOptions email)
          A class which controls the email options.
 void setExceptionHandler(StiWebViewerExceptionHandler exceptionHandler)
          StiWebViewerExceptionHandler Calls on exception while WebDesigner process.
 void setExports(StiWebViewerOptions.ExportOptions exports)
          A class which controls the export options.
 void setHeight(java.lang.String height)
           
 void setJsObject(java.lang.String jsObject)
           
 void setLocalization(java.lang.String localization)
          A path to the localization file for the web viewer.
 void setLocalizationStream(java.io.InputStream localizationStream)
           
 void setMenuAnimation(boolean menuAnimation)
          Deprecated. 
 void setMenuPrintDestination(StiPrintDestination menuPrintDestination)
          Deprecated. 
 void setMenuShowMode(StiShowMenuMode menuShowMode)
          Deprecated. 
 void setMenuZoom(int menuZoom)
          Deprecated. 
 void setOpenExportedReportTarget(java.lang.String openExportedReportTarget)
          Deprecated. 
 void setOpenLinksTarget(java.lang.String openLinksTarget)
          Deprecated. 
 void setPageAlignment(StiContentAlignment pageAlignment)
          Deprecated. 
 void setPageBorderColor(StiColor pageBorderColor)
          Deprecated. 
 void setPageShowShadow(boolean pageShowShadow)
          Deprecated. 
 void setPagesViewMode(StiWebViewMode menuViewMode)
          Deprecated. 
 void setRefreshTimeout(int refreshTimeout)
          A value wich indicates timeout in minutes for execute dummy request to avoid end session
 void setRequestTimeout(java.lang.Integer requestTimeout)
          Timeout AJAX requests in seconds
 void setRightToLeft(boolean rightToLeft)
          Deprecated. 
 void setScrollbarsMode(boolean scrollbarsMode)
          Deprecated. 
 void setServer(StiWebViewerOptions.ServerOptions server)
          A class which controls the server options.
 void setShowAboutButton(boolean showAboutButton)
          Deprecated. 
 void setShowButtonBookmarks(boolean showButtonBookmarks)
          Deprecated. 
 void setShowButtonDesign(boolean showButtonDesign)
          Deprecated. 
 void setShowButtonFirstPage(boolean showButtonFirstPage)
          Deprecated. 
 void setShowButtonLastPage(boolean showButtonLastPage)
          Deprecated. 
 void setShowButtonNextPage(boolean showButtonNextPage)
          Deprecated. 
 void setShowButtonParameters(boolean showButtonParameters)
          Deprecated. 
 void setShowButtonPreviousPage(boolean showButtonPreviousPage)
          Deprecated. 
 void setShowButtonPrint(boolean showButtonPrint)
          Deprecated. 
 void setShowButtonSave(boolean showButtonSave)
          Deprecated. 
 void setShowButtonSendEmail(boolean showButtonSendEmail)
          Deprecated. 
 void setShowButtonViewMode(boolean showButtonViewMode)
          Deprecated. 
 void setShowButtonZoom(boolean showButtonZoom)
          Deprecated. 
 void setShowCurrentPageControl(boolean showCurrentPageControl)
          Deprecated. 
 void setShowEmailDialog(boolean showEmailDialog)
          Deprecated. 
 void setShowExportDialog(boolean showExportDialog)
          Deprecated. 
 void setShowExportToCsv(boolean showExportToCsv)
          Deprecated. 
 void setShowExportToDocument(boolean showExportToDocument)
          Deprecated. 
 void setShowExportToExcel(boolean showExportToExcel)
          Deprecated. 
 void setShowExportToExcel2007(boolean showExportToExcel2007)
          Deprecated. 
 void setShowExportToExcelXml(boolean showExportToExcelXml)
          Deprecated. 
 void setShowExportToHtml(boolean showExportToHtml)
          Deprecated. 
 void setShowExportToImageBmp(boolean showExportToImageBmp)
          Deprecated. 
 void setShowExportToImageJpeg(boolean showExportToImageJpeg)
          Deprecated. 
 void setShowExportToImagePng(boolean showExportToImagePng)
          Deprecated. 
 void setShowExportToImageSvg(boolean showExportToImageSvg)
          Deprecated. 
 void setShowExportToImageSvgz(boolean showExportToImageSvgz)
          Deprecated. 
 void setShowExportToPdf(boolean showExportToPdf)
          Deprecated. 
 void setShowExportToRtf(boolean showExportToRtf)
          Deprecated. 
 void setShowExportToSylk(boolean showExportToSylk)
          Deprecated. 
 void setShowExportToText(boolean showExportToText)
          Deprecated. 
 void setShowExportToWord2007(boolean showExportToWord2007)
          Deprecated. 
 void setShowExportToXml(boolean showExportToXml)
          Deprecated. 
 void setShowExportToXps(boolean showExportToXps)
          Deprecated. 
 void setShowTooltips(boolean showTooltips)
          Deprecated. 
 void setTheme(StiWebViewerTheme theme)
          The current visual theme which is used for drawing visual elements of the webviewer.
 void setToolbar(StiWebViewerOptions.ToolbarOptions toolbar)
          A class which controls settings of the viewer toolbar.
 void setToolbarAlignment(StiContentAlignment toolbarAlignment)
          Deprecated. 
 void setToolbarBackgroundColor(StiColor toolbarBackgroundColor)
          Deprecated. 
 void setToolbarButtonCaptions(boolean toolbarButtonCaptions)
          Deprecated. 
 void setToolbarFontColor(StiColor toolbarFontColor)
          Deprecated. 
 void setToolbarFontFamily(java.lang.String toolbarFontFamily)
          Deprecated. 
 void setToolbarMenuCaptions(boolean toolbarMenuCaptions)
          Deprecated. 
 void setToolbarVisible(boolean toolbarVisible)
          Deprecated. 
 void setViewerID(java.lang.String viewerID)
           
 void setViewerIDInternal(java.lang.String viewerID)
           
 void setWidth(java.lang.String width)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StiWebViewerOptions

public StiWebViewerOptions()
Method Detail

getActions

public JSONObject getActions()

getServer

public StiWebViewerOptions.ServerOptions getServer()
A class which controls the server options.

Returns:
the server

setServer

public void setServer(StiWebViewerOptions.ServerOptions server)
A class which controls the server options.

Parameters:
server - the server to set

getAppearance

public StiWebViewerOptions.AppearanceOptions getAppearance()
A class which controls settings of the viewer appearance.

Returns:
the appearance

setAppearance

public void setAppearance(StiWebViewerOptions.AppearanceOptions appearance)
A class which controls settings of the viewer appearance.

Parameters:
appearance - the appearance to set

getToolbar

public StiWebViewerOptions.ToolbarOptions getToolbar()
A class which controls settings of the viewer toolbar.

Returns:
the toolbar

setToolbar

public void setToolbar(StiWebViewerOptions.ToolbarOptions toolbar)
A class which controls settings of the viewer toolbar.

Parameters:
toolbar - the toolbar to set

getExports

public StiWebViewerOptions.ExportOptions getExports()
A class which controls the export options.

Returns:
the exports

setExports

public void setExports(StiWebViewerOptions.ExportOptions exports)
A class which controls the export options.

Parameters:
exports - the exports to set

getEmail

public StiWebViewerOptions.EmailOptions getEmail()
A class which controls the email options.

Returns:
the email

setEmail

public void setEmail(StiWebViewerOptions.EmailOptions email)
A class which controls the email options.

Parameters:
email - the email to set

getRequestTimeout

public java.lang.Integer getRequestTimeout()
Timeout AJAX requests in seconds

Returns:
the requestTimeout

setRequestTimeout

public void setRequestTimeout(java.lang.Integer requestTimeout)
Timeout AJAX requests in seconds

Parameters:
requestTimeout - the requestTimeout to set

getJsObject

public java.lang.String getJsObject()
Returns:
the jsObject

setJsObject

public void setJsObject(java.lang.String jsObject)
Parameters:
jsObject - the jsObject to set

getViewerID

public java.lang.String getViewerID()
Returns:
the viewerID

setViewerID

public void setViewerID(java.lang.String viewerID)
Parameters:
viewerID - the viewerID to set

setViewerIDInternal

public void setViewerIDInternal(java.lang.String viewerID)
Parameters:
viewerID - the viewerID to set

isServerCacheAsObject

public boolean isServerCacheAsObject()
The mode that caches the report as object.

Returns:
the serverCacheAsObject

getTheme

public StiWebViewerTheme getTheme()
The current visual theme which is used for drawing visual elements of the webviewer.

Returns:
the theme

setTheme

public void setTheme(StiWebViewerTheme theme)
The current visual theme which is used for drawing visual elements of the webviewer.

Parameters:
theme - the theme to set

getWidth

public java.lang.String getWidth()
Returns:
the width

setWidth

public void setWidth(java.lang.String width)
Parameters:
width - must ends width % or px

getHeight

public java.lang.String getHeight()
Returns:
the height

setHeight

public void setHeight(java.lang.String height)
Parameters:
height - must ends width % or px

getBackColor

@Deprecated
public StiColor getBackColor()
Deprecated. 

Use appearance.BackgroundColor();

Returns:
the backColor

setBackColor

@Deprecated
public void setBackColor(StiColor backColor)
Deprecated. 

Use appearance.BackgroundColor();

Parameters:
backColor - the backColor to set

getCountColumnsParameters

@Deprecated
public int getCountColumnsParameters()
Deprecated. 

Use appearance.ParametersPanelColumnsCount(); A count columns in parameters Panel.

Returns:
the countColumnsParameters

setCountColumnsParameters

@Deprecated
public void setCountColumnsParameters(int countColumnsParameters)
Deprecated. 

Use appearance.ParametersPanelColumnsCount(); A count columns in parameters Panel.

Parameters:
countColumnsParameters - the countColumnsParameters to set

getLocalization

public java.lang.String getLocalization()
A path to the localization file for the web viewer.

Returns:
the localization

setLocalization

public void setLocalization(java.lang.String localization)
A path to the localization file for the web viewer.

Parameters:
localization - the localization to set

isRightToLeft

@Deprecated
public boolean isRightToLeft()
Deprecated. 

Use appearance.RightToLeft(rightToLeft) A value which controls of output objects in the right to left mode.

Returns:
the rightToLeft

setRightToLeft

@Deprecated
public void setRightToLeft(boolean rightToLeft)
Deprecated. 

Use appearance.RightToLeft(rightToLeft) A value which controls of output objects in the right to left mode.

Parameters:
rightToLeft - the rightToLeft to set

isScrollbarsMode

@Deprecated
public boolean isScrollbarsMode()
Deprecated. 

Use appearance.ScrollbarsMode() A value which indicates that the web viewer will show the report with

Returns:
the scrollbarsMode

setScrollbarsMode

@Deprecated
public void setScrollbarsMode(boolean scrollbarsMode)
Deprecated. 

Use appearance.ScrollbarsMode() A value which indicates that the web viewer will show the report with

Parameters:
scrollbarsMode - the scrollbarsMode to set

isMenuAnimation

@Deprecated
public boolean isMenuAnimation()
Deprecated. 

Use toolbar.MenuAnimation();

Returns:
the menuAnimation

setMenuAnimation

@Deprecated
public void setMenuAnimation(boolean menuAnimation)
Deprecated. 

Use toolbar.MenuAnimation();

Parameters:
menuAnimation - the menuAnimation to set

getMenuShowMode

@Deprecated
public StiShowMenuMode getMenuShowMode()
Deprecated. 

Use toolbar.showMenuMode

Returns:
the menuShowMode

setMenuShowMode

@Deprecated
public void setMenuShowMode(StiShowMenuMode menuShowMode)
Deprecated. 

Use toolbar.showMenuMode

Parameters:
menuShowMode - the menuShowMode to set

getMenuPrintDestination

@Deprecated
public StiPrintDestination getMenuPrintDestination()
Deprecated. 

Use toolbar.PrintDestination()

Returns:
the menuPrintDestination

setMenuPrintDestination

@Deprecated
public void setMenuPrintDestination(StiPrintDestination menuPrintDestination)
Deprecated. 

Use toolbar.PrintDestination()

Parameters:
menuPrintDestination - the menuPrintDestination to set

getPagesViewMode

@Deprecated
public StiWebViewMode getPagesViewMode()
Deprecated. 

The mode of showing a report in the web viewer - one page or the whole report.

Returns:
the menuViewMode

setPagesViewMode

@Deprecated
public void setPagesViewMode(StiWebViewMode menuViewMode)
Deprecated. 

The mode of showing a report in the web viewer - one page or the whole report.

Parameters:
menuViewMode - the menuViewMode to set

getMenuZoom

@Deprecated
public int getMenuZoom()
Deprecated. 

Use toolbar.Zoom()

Returns:
the menuZoom

setMenuZoom

@Deprecated
public void setMenuZoom(int menuZoom)
Deprecated. 

Use toolbar.Zoom()

Parameters:
menuZoom - the menuZoom to set

getPageAlignment

@Deprecated
public StiContentAlignment getPageAlignment()
Deprecated. 

Use appearance.getPageAlignment()

Returns:
the pageAlignment

setPageAlignment

@Deprecated
public void setPageAlignment(StiContentAlignment pageAlignment)
Deprecated. 

appearance.getPageAlignment()

Parameters:
pageAlignment - the pageAlignment to set

isPageShowShadow

@Deprecated
public boolean isPageShowShadow()
Deprecated. 

Use appearance.ShowPageShadow()

Returns:
the pageShowShadow

setPageShowShadow

@Deprecated
public void setPageShowShadow(boolean pageShowShadow)
Deprecated. 

Use appearance.ShowPageShadow()

Parameters:
pageShowShadow - the pageShowShadow to set

getPageBorderColor

@Deprecated
public StiColor getPageBorderColor()
Deprecated. 

Use appearance.PageBorderColor()

Returns:
the pageBorderColor

setPageBorderColor

@Deprecated
public void setPageBorderColor(StiColor pageBorderColor)
Deprecated. 

Use appearance.PageBorderColor()

Parameters:
pageBorderColor - the pageBorderColor to set

isBookmarksVisible

@Deprecated
public boolean isBookmarksVisible()
Deprecated. 

A visibility of the Toolbar of the web viewer.

Returns:
the bookmarksVisible

setBookmarksVisible

@Deprecated
public void setBookmarksVisible(boolean bookmarksVisible)
Deprecated. 

A visibility of the Toolbar of the web viewer.

Parameters:
bookmarksVisible - the bookmarksVisible to set

isBookmarksPrint

@Deprecated
public boolean isBookmarksPrint()
Deprecated. 

Use appearance.isBookmarksPrint()

Returns:
the bookmarksPrint

setBookmarksPrint

@Deprecated
public void setBookmarksPrint(boolean bookmarksPrint)
Deprecated. 

Use appearance.isBookmarksPrint()

Parameters:
bookmarksPrint - the bookmarksPrint to set

getBookmarksTreeWidth

@Deprecated
public int getBookmarksTreeWidth()
Deprecated. 

Use appearance.getBookmarksTreeWidth()

Returns:
the bookmarksTreeWidth

setBookmarksTreeWidth

@Deprecated
public void setBookmarksTreeWidth(int bookmarksTreeWidth)
Deprecated. 

Use appearance.getBookmarksTreeWidth()

Parameters:
bookmarksTreeWidth - the bookmarksTreeWidth to set

isToolbarVisible

@Deprecated
public boolean isToolbarVisible()
Deprecated. 

Use toolbar.Visible()

Returns:
the toolbarVisible

setToolbarVisible

@Deprecated
public void setToolbarVisible(boolean toolbarVisible)
Deprecated. 

Use toolbar.Visible()

Parameters:
toolbarVisible - the toolbarVisible to set

getToolbarBackgroundColor

@Deprecated
public StiColor getToolbarBackgroundColor()
Deprecated. 

Use toolbar.BackgroundColor()

Returns:
the toolbarBackgroundColor

setToolbarBackgroundColor

@Deprecated
public void setToolbarBackgroundColor(StiColor toolbarBackgroundColor)
Deprecated. 

Use toolbar.BackgroundColor()

Parameters:
toolbarBackgroundColor - the toolbarBackgroundColor to set

getToolbarFontColor

@Deprecated
public StiColor getToolbarFontColor()
Deprecated. 

Use toolbar.FontColor()

Returns:
the toolbarFontColor

setToolbarFontColor

@Deprecated
public void setToolbarFontColor(StiColor toolbarFontColor)
Deprecated. 

Use toolbar.FontColor()

Parameters:
toolbarFontColor - the toolbarFontColor to set

getToolbarFontFamily

@Deprecated
public java.lang.String getToolbarFontFamily()
Deprecated. 

Use toolbar.getFontFamily()

Returns:
the toolbarFontFamily

setToolbarFontFamily

@Deprecated
public void setToolbarFontFamily(java.lang.String toolbarFontFamily)
Deprecated. 

Use toolbar.getFontFamily()

Parameters:
toolbarFontFamily - the toolbarFontFamily to set

getToolbarAlignment

@Deprecated
public StiContentAlignment getToolbarAlignment()
Deprecated. 

Use toolbar.Alignment()

Returns:
the toolbarAlignment

setToolbarAlignment

@Deprecated
public void setToolbarAlignment(StiContentAlignment toolbarAlignment)
Deprecated. 

Use toolbar.Alignment()

Parameters:
toolbarAlignment - the toolbarAlignment to set

isToolbarButtonCaptions

@Deprecated
public boolean isToolbarButtonCaptions()
Deprecated. 

Use toolbar.ShowButtonCaptions()

Returns:
the toolbarButtonCaptions

setToolbarButtonCaptions

@Deprecated
public void setToolbarButtonCaptions(boolean toolbarButtonCaptions)
Deprecated. 

Use toolbar.ShowButtonCaptions()

Parameters:
toolbarButtonCaptions - the toolbarButtonCaptions to set

isToolbarMenuCaptions

@Deprecated
public boolean isToolbarMenuCaptions()
Deprecated. 


setToolbarMenuCaptions

@Deprecated
public void setToolbarMenuCaptions(boolean toolbarMenuCaptions)
Deprecated. 


isShowCurrentPageControl

@Deprecated
public boolean isShowCurrentPageControl()
Deprecated. 

Use toolbar.ShowCurrentPageControl()

Returns:
the showCurrentPageControl

setShowCurrentPageControl

@Deprecated
public void setShowCurrentPageControl(boolean showCurrentPageControl)
Deprecated. 

Use toolbar.ShowCurrentPageControl()

Parameters:
showCurrentPageControl - the showCurrentPageControl to set

isShowButtonPrint

@Deprecated
public boolean isShowButtonPrint()
Deprecated. 

Use toolbar.ShowPrintButton()

Returns:
the showButtonPrint

setShowButtonPrint

@Deprecated
public void setShowButtonPrint(boolean showButtonPrint)
Deprecated. 

Use toolbar.ShowPrintButton()

Parameters:
showButtonPrint - the showButtonPrint to set

isShowButtonSave

@Deprecated
public boolean isShowButtonSave()
Deprecated. 

Use toolbar.ShowSaveButton()

Returns:
the showButtonSave

setShowButtonSave

@Deprecated
public void setShowButtonSave(boolean showButtonSave)
Deprecated. 

Use toolbar.ShowSaveButton()

Parameters:
showButtonSave - the showButtonSave to set

isShowButtonBookmarks

@Deprecated
public boolean isShowButtonBookmarks()
Deprecated. 

Use toolbar.ShowBookmarksButton()

Returns:
the showButtonBookmarks

setShowButtonBookmarks

@Deprecated
public void setShowButtonBookmarks(boolean showButtonBookmarks)
Deprecated. 

Use toolbar.ShowBookmarksButton()

Parameters:
showButtonBookmarks - the showButtonBookmarks to set

isShowButtonParameters

@Deprecated
public boolean isShowButtonParameters()
Deprecated. 

Use toolbar.ShowParametersButton()

Returns:
the showButtonParameters

setShowButtonParameters

@Deprecated
public void setShowButtonParameters(boolean showButtonParameters)
Deprecated. 

Use toolbar.ShowParametersButton()

Parameters:
showButtonParameters - the showButtonParameters to set

isShowButtonFirstPage

@Deprecated
public boolean isShowButtonFirstPage()
Deprecated. 

Use toolbar.ShowFirstPageButton()

Returns:
the showButtonFirstPage

setShowButtonFirstPage

@Deprecated
public void setShowButtonFirstPage(boolean showButtonFirstPage)
Deprecated. 

Use toolbar.ShowFirstPageButton()

Parameters:
showButtonFirstPage - the showButtonFirstPage to set

isShowButtonPreviousPage

@Deprecated
public boolean isShowButtonPreviousPage()
Deprecated. 

Use toolbar.ShowPreviousPageButton()

Returns:
the showButtonPreviousPage

setShowButtonPreviousPage

@Deprecated
public void setShowButtonPreviousPage(boolean showButtonPreviousPage)
Deprecated. 

Use toolbar.ShowPreviousPageButton()

Parameters:
showButtonPreviousPage - the showButtonPreviousPage to set

isShowButtonNextPage

@Deprecated
public boolean isShowButtonNextPage()
Deprecated. 

Use toolbar.ShowNextPageButton()

Returns:
the showButtonNextPage

setShowButtonNextPage

@Deprecated
public void setShowButtonNextPage(boolean showButtonNextPage)
Deprecated. 

Use toolbar.ShowNextPageButton()

Parameters:
showButtonNextPage - the showButtonNextPage to set

isShowButtonLastPage

@Deprecated
public boolean isShowButtonLastPage()
Deprecated. 

Use toolbar.ShowLastPageButton()

Returns:
the showButtonLastPage

setShowButtonLastPage

@Deprecated
public void setShowButtonLastPage(boolean showButtonLastPage)
Deprecated. 

Use toolbar.ShowLastPageButton()

Parameters:
showButtonLastPage - the showButtonLastPage to set

isShowButtonZoom

@Deprecated
public boolean isShowButtonZoom()
Deprecated. 

Use toolbar.ShowZoomButton()

Returns:
the showButtonZoom

setShowButtonZoom

@Deprecated
public void setShowButtonZoom(boolean showButtonZoom)
Deprecated. 

Use toolbar.ShowZoomButton()

Parameters:
showButtonZoom - the showButtonZoom to set

isShowButtonViewMode

@Deprecated
public boolean isShowButtonViewMode()
Deprecated. 

Use toolbar.ShowViewModeButton()

Returns:
the showButtonViewMode

setShowButtonViewMode

@Deprecated
public void setShowButtonViewMode(boolean showButtonViewMode)
Deprecated. 

Use toolbar.ShowViewModeButton()

Parameters:
showButtonViewMode - the showButtonViewMode to set

isShowButtonDesign

@Deprecated
public boolean isShowButtonDesign()
Deprecated. 

Use toolbar.ShowDesignButton()

Returns:
the showButtonDesign

setShowButtonDesign

@Deprecated
public void setShowButtonDesign(boolean showButtonDesign)
Deprecated. 

Use toolbar.ShowDesignButton()

Parameters:
showButtonDesign - the showButtonDesign to set

isShowExportDialog

@Deprecated
public boolean isShowExportDialog()
Deprecated. 

Use exports.ShowExportDialog()

Returns:
the showExportDialog

setShowExportDialog

@Deprecated
public void setShowExportDialog(boolean showExportDialog)
Deprecated. 

Use exports.ShowExportDialog()

Parameters:
showExportDialog - the showExportDialog to set

isShowExportToDocument

@Deprecated
public boolean isShowExportToDocument()
Deprecated. 

Use exports.ShowExportToDocument();

Returns:
the showExportToDocument

setShowExportToDocument

@Deprecated
public void setShowExportToDocument(boolean showExportToDocument)
Deprecated. 

Use exports.ShowExportToDocument();

Parameters:
showExportToDocument - the showExportToDocument to set

isShowExportToPdf

@Deprecated
public boolean isShowExportToPdf()
Deprecated. 

Use exports.ShowExportToPdf()

Returns:
the showExportToPdf

setShowExportToPdf

@Deprecated
public void setShowExportToPdf(boolean showExportToPdf)
Deprecated. 

Use exports.ShowExportToPdf()

Parameters:
showExportToPdf - the showExportToPdf to set

isShowExportToXps

@Deprecated
public boolean isShowExportToXps()
Deprecated. 

Use exports.ShowExportToXps()

Returns:
the showExportToXps

setShowExportToXps

@Deprecated
public void setShowExportToXps(boolean showExportToXps)
Deprecated. 

Use exports.ShowExportToXps()

Parameters:
showExportToXps - the showExportToXps to set

isShowExportToPowerPoint

public boolean isShowExportToPowerPoint()
Returns:
the showExportToPowerPoint

isShowExportToHtml

@Deprecated
public boolean isShowExportToHtml()
Deprecated. 

Use exports.ShowExportToHtml()

Returns:
the showExportToHtml

setShowExportToHtml

@Deprecated
public void setShowExportToHtml(boolean showExportToHtml)
Deprecated. 

Use exports.ShowExportToHtml()

Parameters:
showExportToHtml - the showExportToHtml to set

isShowExportToHtml5

@Deprecated
public boolean isShowExportToHtml5()
Deprecated. 

Returns:
the showExportToHtml5

isShowExportToMht

@Deprecated
public boolean isShowExportToMht()
Deprecated. 

Returns:
the showExportToMht

isShowExportToText

@Deprecated
public boolean isShowExportToText()
Deprecated. 

Use exports.ShowExportToText()

Returns:
the showExportToText

setShowExportToText

@Deprecated
public void setShowExportToText(boolean showExportToText)
Deprecated. 

Use exports.ShowExportToText()

Parameters:
showExportToText - the showExportToText to set

isShowExportToRtf

@Deprecated
public boolean isShowExportToRtf()
Deprecated. 

Use exports.ShowExportToRtf()

Returns:
the showExportToRtf

setShowExportToRtf

@Deprecated
public void setShowExportToRtf(boolean showExportToRtf)
Deprecated. 

Use exports.ShowExportToRtf()

Parameters:
showExportToRtf - the showExportToRtf to set

isShowExportToWord2007

@Deprecated
public boolean isShowExportToWord2007()
Deprecated. 

Use exports.ShowExportToWord2007()

Returns:
the showExportToWord2007

setShowExportToWord2007

@Deprecated
public void setShowExportToWord2007(boolean showExportToWord2007)
Deprecated. 

Use exports.ShowExportToWord2007()

Parameters:
showExportToWord2007 - the showExportToWord2007 to set

isShowExportToOpenDocumentWriter

@Deprecated
public boolean isShowExportToOpenDocumentWriter()
Deprecated. 

Returns:
the showExportToOpenDocumentWriter

isShowExportToExcel

@Deprecated
public boolean isShowExportToExcel()
Deprecated. 

Use exports.ShowExportToExcel();

Returns:
the showExportToExcel

setShowExportToExcel

@Deprecated
public void setShowExportToExcel(boolean showExportToExcel)
Deprecated. 

Use exports.ShowExportToExcel();

Parameters:
showExportToExcel - the showExportToExcel to set

isShowExportToExcelXml

@Deprecated
public boolean isShowExportToExcelXml()
Deprecated. 

Use exports.ShowExportToExcelXml()

Returns:
the showExportToExcelXml

setShowExportToExcelXml

@Deprecated
public void setShowExportToExcelXml(boolean showExportToExcelXml)
Deprecated. 

Use exports.ShowExportToExcelXml()

Parameters:
showExportToExcelXml - the showExportToExcelXml to set

isShowExportToExcel2007

@Deprecated
public boolean isShowExportToExcel2007()
Deprecated. 

Use exports.ShowExportToExcel2007();

Returns:
the showExportToExcel2007

setShowExportToExcel2007

@Deprecated
public void setShowExportToExcel2007(boolean showExportToExcel2007)
Deprecated. 

Use exports.ShowExportToExcel2007();

Parameters:
showExportToExcel2007 - the showExportToExcel2007 to set

isShowExportToOpenDocumentCalc

@Deprecated
public boolean isShowExportToOpenDocumentCalc()
Deprecated. 

Returns:
the showExportToOpenDocumentCalc

isShowExportToCsv

@Deprecated
public boolean isShowExportToCsv()
Deprecated. 

Use exports.ShowExportToCsv();

Returns:
the showExportToCsv

setShowExportToCsv

@Deprecated
public void setShowExportToCsv(boolean showExportToCsv)
Deprecated. 

Use exports.ShowExportToCsv();

Parameters:
showExportToCsv - the showExportToCsv to set

isShowExportToDbf

@Deprecated
public boolean isShowExportToDbf()
Deprecated. 

Returns:
the showExportToDbf

isShowExportToXml

@Deprecated
public boolean isShowExportToXml()
Deprecated. 

Use exports.ShowExportToXml()

Returns:
the showExportToXml

setShowExportToXml

@Deprecated
public void setShowExportToXml(boolean showExportToXml)
Deprecated. 

Use exports.ShowExportToXml()

Parameters:
showExportToXml - the showExportToXml to set

isShowExportToDif

@Deprecated
public boolean isShowExportToDif()
Deprecated. 

Returns:
the showExportToDif

isShowExportToSylk

@Deprecated
public boolean isShowExportToSylk()
Deprecated. 

Use exports.ShowExportToSylk()

Returns:
the showExportToSylk

setShowExportToSylk

@Deprecated
public void setShowExportToSylk(boolean showExportToSylk)
Deprecated. 

Use exports.ShowExportToSylk()

Parameters:
showExportToSylk - the showExportToSylk to set

isShowExportToImageBmp

@Deprecated
public boolean isShowExportToImageBmp()
Deprecated. 

Use exports.ShowExportToImageBmp()

Returns:
the showExportToImageBmp

setShowExportToImageBmp

@Deprecated
public void setShowExportToImageBmp(boolean showExportToImageBmp)
Deprecated. 

Use exports.ShowExportToImageBmp()

Parameters:
showExportToImageBmp - the showExportToImageBmp to set

isShowExportToImageGif

@Deprecated
public boolean isShowExportToImageGif()
Deprecated. 

Returns:
the showExportToImageGif

isShowExportToImageJpeg

@Deprecated
public boolean isShowExportToImageJpeg()
Deprecated. 

Use exports.isShowExportToImageJpeg

Returns:
the showExportToImageJpeg

setShowExportToImageJpeg

@Deprecated
public void setShowExportToImageJpeg(boolean showExportToImageJpeg)
Deprecated. 

exports.isShowExportToImageJpeg

Parameters:
showExportToImageJpeg - the showExportToImageJpeg to set

isShowExportToImagePcx

@Deprecated
public boolean isShowExportToImagePcx()
Deprecated. 

Use exports.ShowExportToImagePcx();

Returns:
the showExportToImagePcx

isShowExportToImagePng

@Deprecated
public boolean isShowExportToImagePng()
Deprecated. 

Use exports.ShowExportToImagePng()

Returns:
the showExportToImagePng

setShowExportToImagePng

@Deprecated
public void setShowExportToImagePng(boolean showExportToImagePng)
Deprecated. 

Use exports.ShowExportToImagePng()

Parameters:
showExportToImagePng - the showExportToImagePng to set

isShowExportToImageTiff

@Deprecated
public boolean isShowExportToImageTiff()
Deprecated. 

Returns:
the showExportToImageTiff

isShowExportToImageMetafile

@Deprecated
public boolean isShowExportToImageMetafile()
Deprecated. 

Returns:
the showExportToImageMetafile

isShowExportToImageSvg

@Deprecated
public boolean isShowExportToImageSvg()
Deprecated. 

Use exports.ShowExportToImageSvg()

Returns:
the showExportToImageSvg

setShowExportToImageSvg

@Deprecated
public void setShowExportToImageSvg(boolean showExportToImageSvg)
Deprecated. 

Use exports.ShowExportToImageSvg()

Parameters:
showExportToImageSvg - the showExportToImageSvg to set

isShowExportToImageSvgz

@Deprecated
public boolean isShowExportToImageSvgz()
Deprecated. 

Use exports.ShowExportToImageSvgz()

Returns:
the showExportToImageSvgz

setShowExportToImageSvgz

@Deprecated
public void setShowExportToImageSvgz(boolean showExportToImageSvgz)
Deprecated. 

Use exports.ShowExportToImageSvgz()

Parameters:
showExportToImageSvgz - the showExportToImageSvgz to set

getRefreshTimeout

public int getRefreshTimeout()
A value wich indicates timeout in minutes for execute dummy request to avoid end session

Returns:
the refreshTimeout

setRefreshTimeout

public void setRefreshTimeout(int refreshTimeout)
A value wich indicates timeout in minutes for execute dummy request to avoid end session

Parameters:
refreshTimeout - the refreshTimeout to set

getOpenExportedReportTarget

@Deprecated
public java.lang.String getOpenExportedReportTarget()
Deprecated. 

Use appearance.OpenExportedReportTarget()

Returns:
a target to open the exported report.

setOpenExportedReportTarget

@Deprecated
public void setOpenExportedReportTarget(java.lang.String openExportedReportTarget)
Deprecated. 

Use appearance.OpenExportedReportTarget() A target to open the exported report.

Parameters:
openExportedReportTarget - the openExportedReportTarget to set

getOpenLinksTarget

@Deprecated
public java.lang.String getOpenLinksTarget()
Deprecated. 

Use appearance.OpenLinksTarget()

Returns:
a target to open links from the report.

setOpenLinksTarget

@Deprecated
public void setOpenLinksTarget(java.lang.String openLinksTarget)
Deprecated. 

Use appearance.OpenLinksTarget() A target to open links from the report.

Parameters:
openLinksTarget - the openLinksTarget to set

isShowAboutButton

@Deprecated
public boolean isShowAboutButton()
Deprecated. 

Returns:
the showAboutButton

setShowAboutButton

@Deprecated
public void setShowAboutButton(boolean showAboutButton)
Deprecated. 

Parameters:
showAboutButton - the showAboutButton to set

isShowTooltips

@Deprecated
public boolean isShowTooltips()
Deprecated. 

Returns:
the showTooltips

setShowTooltips

@Deprecated
public void setShowTooltips(boolean showTooltips)
Deprecated. 

Use appearance.isShowTooltips()

Parameters:
showTooltips - the showTooltips to set

getDefaultExportSettings

public java.util.Collection<StiExportSettings> getDefaultExportSettings()
An array of export settings that will be used by default.

Returns:
the defaultExportSettings

setDefaultExportSettings

public void setDefaultExportSettings(java.util.Collection<StiExportSettings> defaultExportSettings)
An array of export settings that will be used by default.

Parameters:
defaultExportSettings - the defaultExportSettings to set

isShowButtonSendEmail

@Deprecated
public boolean isShowButtonSendEmail()
Deprecated. 

Use toolbar.ShowEditorButton()

Returns:
the showButtonSendEmail

setShowButtonSendEmail

@Deprecated
public void setShowButtonSendEmail(boolean showButtonSendEmail)
Deprecated. 

Use toolbar.ShowEditorButton()

Parameters:
showButtonSendEmail - the showButtonSendEmail to set

isShowEmailDialog

@Deprecated
public boolean isShowEmailDialog()
Deprecated. 

Use email.ShowEmailDialog()

Returns:
the showEmailDialog

setShowEmailDialog

@Deprecated
public void setShowEmailDialog(boolean showEmailDialog)
Deprecated. 

Use email.ShowEmailDialog()

Parameters:
showEmailDialog - the showEmailDialog to set

getDefaultEmailAdress

@Deprecated
public java.lang.String getDefaultEmailAdress()
Deprecated. 

Use email.DefaultEmailAddress()

Returns:
the defaultEmailAdress

setDefaultEmailAdress

@Deprecated
public void setDefaultEmailAdress(java.lang.String defaultEmailAdress)
Deprecated. 

Use email.DefaultEmailAddress()

Parameters:
defaultEmailAdress - the defaultEmailAdress to set

getDefaultEmailSubject

@Deprecated
public java.lang.String getDefaultEmailSubject()
Deprecated. 

Use email.DefaultEmailSubject()

Returns:
the defaultEmailSubject

setDefaultEmailSubject

@Deprecated
public void setDefaultEmailSubject(java.lang.String defaultEmailSubject)
Deprecated. 

Use email.DefaultEmailSubject()

Parameters:
defaultEmailSubject - the defaultEmailSubject to set

getDefaultEmailMessage

@Deprecated
public java.lang.String getDefaultEmailMessage()
Deprecated. 

Use email.DefaultEmailMessage()

Returns:
the defaultEmailMessage

setDefaultEmailMessage

@Deprecated
public void setDefaultEmailMessage(java.lang.String defaultEmailMessage)
Deprecated. 

Use email.DefaultEmailMessage()

Parameters:
defaultEmailMessage - the defaultEmailMessage to set

getExceptionHandler

public StiWebViewerExceptionHandler getExceptionHandler()
StiWebViewerExceptionHandler Calls on exception while WebDesigner process.

Returns:
the exceptionHandler

setExceptionHandler

public void setExceptionHandler(StiWebViewerExceptionHandler exceptionHandler)
StiWebViewerExceptionHandler Calls on exception while WebDesigner process.

Parameters:
exceptionHandler - the exceptionHandler to set

getLocalizationStream

public java.io.InputStream getLocalizationStream()
Returns:
the localizationStream

setLocalizationStream

public void setLocalizationStream(java.io.InputStream localizationStream)
Parameters:
localizationStream - the localizationStream to set