com.stimulsoft.webviewer
Class StiWebViewerOptions.AppearanceOptions

java.lang.Object
  com.stimulsoft.webviewer.StiWebViewerOptions.AppearanceOptions

Enclosing class:

StiWebViewerOptions

public class StiWebViewerOptions.AppearanceOptions
extends java.lang.Object

Field Summary

java.lang.String	customCss
StiParametersPanelPosition	parametersPanelPosition
StiPrintToPdfMode	printToPdfMode

Constructor Summary

StiWebViewerOptions.AppearanceOptions()

Method Summary

StiColor	getBackgroundColor() The background color of the viewer.
int	getBookmarksTreeWidth() A width of the bookmarks tree in the viewer.
StiHtmlChartType	getChartRenderType() The type of the chart in the viewer.
java.lang.String	getCustomCss() a path to the custom css file for the viewer.
StiFirstDayOfWeek	getDatePickerFirstDayOfWeek() the first day of week in the date picker.
java.lang.String	getDesignWindow() a browser window to open page at design event.
StiInterfaceType	getInterfaceType() The type of the viewer interface.
java.lang.String	getOpenExportedReportTarget() A target to open the exported report.
java.lang.String	getOpenExportedReportWindow() a browser window to open the exported report.
java.lang.String	getOpenLinksTarget() A target to open links from the report.
java.lang.String	getOpenLinksWindow() a browser window to open links from the report.
StiContentAlignment	getPageAlignment() The alignment of the viewer page.
StiColor	getPageBorderColor() A color of the report page border.
int	getParametersPanelColumnsCount() A count columns in parameters panel.
java.lang.String	getParametersPanelDateFormat() A date format for datetime parameters in parameters panel.
int	getParametersPanelMaxHeight() A max height of parameters panel in the viewer.
StiParametersPanelPosition	getParametersPanelPosition() a position of the parameters panel.
StiPrintToPdfMode	getPrintToPdfMode()
StiReportDisplayMode	getReportDisplayMode() a method how the viewer will show a report.
boolean	isAllowTouchZoom() A value which allows touch zoom in the viewer.
boolean	isBookmarksPrint() A value which allows printing report bookmarks.
boolean	isFullScreenMode() A value which indicates which indicates that the viewer is displayed in full screen mode.
boolean	isRightToLeft() A value which controls of output objects in the right to left mode.
boolean	isScrollbarsMode() A value which indicates that the viewer will show the report area with scrollbars.
boolean	isShowPageShadow() A value which indicates that the shadow of the page will be displayed in the viewer.
boolean	isShowTooltips() A value which indicates that show or hide tooltips.
boolean	isShowTooltipsHelp() a value which indicates that show or hide the help link in tooltips.
boolean	isStoreExportSettings() a value which allows store the export settings in the cookies.
void	setAllowTouchZoom(boolean allowTouchZoom) A value which allows touch zoom in the viewer.
void	setBackgroundColor(StiColor backgroundColor) The background color of the viewer.
void	setBookmarksPrint(boolean bookmarksPrint) A value which allows printing report bookmarks.
void	setBookmarksTreeWidth(int bookmarksTreeWidth) A width of the bookmarks tree in the viewer.
void	setChartRenderType(StiHtmlChartType chartRenderType)
void	setCustomCss(java.lang.String customCss) a path to the custom css file for the viewer.
void	setDatePickerFirstDayOfWeek(StiFirstDayOfWeek datePickerFirstDayOfWeek) the first day of week in the date picker.
void	setDesignWindow(java.lang.String designWindow) a browser window to open page at design event.
void	setFullScreenMode(boolean fullScreenMode) A value which indicates which indicates that the viewer is displayed in full screen mode.
void	setInterfaceType(StiInterfaceType interfaceType) The type of the viewer interface.
void	setOpenExportedReportTarget(java.lang.String openExportedReportTarget) A target to open the exported report.
void	setOpenExportedReportWindow(java.lang.String openExportedReportWindow) a browser window to open the exported report.
void	setOpenLinksTarget(java.lang.String openLinksTarget) A target to open links from the report.
void	setOpenLinksWindow(java.lang.String openLinksWindow) a browser window to open links from the report.
void	setPageAlignment(StiContentAlignment pageAlignment) The alignment of the viewer page.
void	setPageBorderColor(StiColor pageBorderColor) A color of the report page border.
void	setParametersPanelColumnsCount(int parametersPanelColumnsCount) A count columns in parameters panel.
void	setParametersPanelDateFormat(java.lang.String parametersPanelDateFormat) A date format for datetime parameters in parameters panel.
void	setParametersPanelMaxHeight(int parametersPanelMaxHeight) A max height of parameters panel in the viewer.
void	setParametersPanelPosition(StiParametersPanelPosition parametersPanelPosition) a position of the parameters panel.
void	setPrintToPdfMode(StiPrintToPdfMode printToPdfMode)
void	setReportDisplayMode(StiReportDisplayMode reportDisplayMode) a method how the viewer will show a report.
void	setRightToLeft(boolean rightToLeft) A value which controls of output objects in the right to left mode.
void	setScrollbarsMode(boolean scrollbarsMode) A value which indicates that the viewer will show the report area with scrollbars.
void	setShowPageShadow(boolean showPageShadow) A value which indicates that the shadow of the page will be displayed in the viewer.
void	setShowTooltips(boolean showTooltips) A value which indicates that show or hide tooltips.
void	setShowTooltipsHelp(boolean showTooltipsHelp) a value which indicates that show or hide the help link in tooltips.
void	setStoreExportSettings(boolean storeExportSettings) a value which allows store the export settings in the cookies.

Methods inherited from class java.lang.Object

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

Field Detail

parametersPanelPosition

public StiParametersPanelPosition parametersPanelPosition

customCss

public java.lang.String customCss

printToPdfMode

public StiPrintToPdfMode printToPdfMode

Constructor Detail

StiWebViewerOptions.AppearanceOptions

public StiWebViewerOptions.AppearanceOptions()

Method Detail

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 java.lang.String getCustomCss()

a path to the custom css file for the viewer.

Returns:

the customCss

setCustomCss

public void setCustomCss(java.lang.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 java.lang.String getDesignWindow()

a browser window to open page at design event. _self or _blank

Returns:

the designWindow

setDesignWindow

public void setDesignWindow(java.lang.String designWindow)

a browser window to open page at design event. _self or _blank

Parameters:

designWindow - the designWindow to set

getOpenExportedReportWindow

public java.lang.String getOpenExportedReportWindow()

a browser window to open the exported report. _self or _blank

Returns:

the openExportedReportWindow

setOpenExportedReportWindow

public void setOpenExportedReportWindow(java.lang.String openExportedReportWindow)

a browser window to open the exported report. _self or _blank

Parameters:

openExportedReportWindow - the openExportedReportWindow to set

getOpenLinksWindow

public java.lang.String getOpenLinksWindow()

a browser window to open links from the report. _self or _blank

Returns:

the openLinksWindow

setOpenLinksWindow

public void setOpenLinksWindow(java.lang.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 java.lang.String getOpenLinksTarget()

A target to open links from the report.

Returns:

the openLinksTarget

setOpenLinksTarget

public void setOpenLinksTarget(java.lang.String openLinksTarget)

A target to open links from the report.

Parameters:

openLinksTarget - the openLinksTarget to set

getOpenExportedReportTarget

public java.lang.String getOpenExportedReportTarget()

A target to open the exported report.

Returns:

the openExportedReportTarget

setOpenExportedReportTarget

public void setOpenExportedReportTarget(java.lang.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 java.lang.String getParametersPanelDateFormat()

A date format for datetime parameters in parameters panel.

Returns:

the parametersPanelDateFormat

setParametersPanelDateFormat

public void setParametersPanelDateFormat(java.lang.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