com.stimulsoft.report.design
Class StiDesignerInfo

java.lang.Object
  extended by com.stimulsoft.report.design.StiDesignerInfo

public class StiDesignerInfo
extends java.lang.Object

Describes the class of report parameters for the designer.


Constructor Summary
StiDesignerInfo()
          Creates a new object of the type StiDesignerInfo.
StiDesignerInfo(StiReport report)
          Creates a new object of the type StiDesignerInfo.
 
Method Summary
 boolean getAlignToGrid()
          Gets or sets value, indicates that components are to be aligned to grid.
 int getAutoSaveInterval()
           
 boolean getAutoSaveReportToReportClass()
           
 StiComponent getBookmarkComponent()
           
 StiAction getCurrentAction()
          Currect action in designer.
 boolean getDrawEventMarkers()
           
 boolean getDrawMarkersWhenMoving()
           
 boolean getEnableAutoSaveMode()
           
 boolean getFillBands()
          Gets or sets value, indicates that bands are to be filled when drawing them in the designer.
 boolean getFillComponent()
          Gets or sets value indicates that it is necessary to fill components when drawing them in the designer.
 boolean getFillContainer()
          Gets or sets value indicates that it is necessary to fill containers when drawing them in the designer.
 boolean getFillCrossBands()
          Gets or sets value, indicates that cross-bands are to be filled when drawing them in the designer.
 boolean getForceDesigningMode()
          Temporarily sets mode of the designing of components.
 boolean getGenerateLocalizedName()
           
 StiGridMode getGridMode()
          Gets or sets grid mode.
 double getGridSize()
           
 double getGridSizeCentimetres()
          Gets or sets grid size in centimeters.
 double getGridSizeHundredthsOfInch()
          Gets or sets grid size in hundredths of inch.
 double getGridSizeInch()
          Gets or sets grid size in inches.
 double getGridSizeMillimeters()
          Gets or sets grid size in millimeters.
 double getGridSizePixels()
          Gets or sets grid size in pixels.
 boolean getIsComponentsMoving()
           
 boolean getIsTableMode()
           
 StiMarkersStyle getMarkersStyle()
           
 double getPageZoom()
           
 boolean getQuickInfoOverlay()
           
 StiQuickInfoType getQuickInfoType()
           
 StiReport getReport()
          Gets or sets the report to which these parameters belong.
 boolean getRunDesignerAfterInsert()
          Gets or sets value, indicates that it is necessary to run the component designer after the component has been created.
 boolean getShowDimensionLines()
           
 boolean getShowGrid()
          Gets or sets value indicates that it is necessary to show grid on a page.
 boolean getShowHeaders()
          Gets or sets value, indicates that component headers are to be shown from components.
 boolean getShowInteractive()
           
 boolean getShowOrder()
          Gets or sets value, indicates that order of components is to be shown on the page.
 boolean getShowRulers()
          Gets or sets value, indicates that it is necessary to show rulers.
 boolean getUseComponentColor()
          Gets or sets value indicates that, when filling components, use colors in the designer parameters.
 boolean getUseLastFormat()
          Gets or sets value, indicates that format from last selected component copy to new components.
 StiViewMode getViewMode()
          Gets or sets the view mode of a page.
 double getZoom()
          Gets or sets zoom of a report (1 = 100%).
 java.lang.Boolean isBookmarked(StiComponent component)
           
 boolean isExporting()
           
 void setAlignToGrid(boolean value)
           
 void setAutoSaveInterval(int value)
           
 void setAutoSaveReportToReportClass(boolean value)
           
 void setBookmarkComponent(StiComponent bookmarkComponent)
           
 void setCurrentAction(StiAction value)
           
 void setDrawEventMarkers(boolean value)
           
 void setDrawMarkersWhenMoving(boolean value)
           
 void setEnableAutoSaveMode(boolean value)
           
 void setExporting(boolean exporting)
           
 void setFillBands(boolean value)
           
 void setFillComponent(boolean value)
           
 void setFillContainer(boolean value)
           
 void setFillCrossBands(boolean value)
           
 void setForceDesigningMode(boolean value)
           
 void setGenerateLocalizedName(boolean value)
           
 void setGridMode(StiGridMode value)
           
 void setGridSizeCentimetres(double value)
           
 void setGridSizeHundredthsOfInch(double value)
           
 void setGridSizeInch(double value)
           
 void setGridSizeMillimeters(double value)
           
 void setGridSizePixels(double value)
           
 void setIsComponentsMoving(boolean value)
           
 void setIsTableMode(boolean value)
           
 void setMarkersStyle(StiMarkersStyle value)
           
 void setPageZoom(double pageZoom)
           
 void setQuickInfoOverlay(boolean value)
           
 void setQuickInfoType(StiQuickInfoType value)
           
 void setReport(StiReport value)
           
 void setRunDesignerAfterInsert(boolean value)
           
 void setShowDimensionLines(boolean value)
           
 void setShowGrid(boolean value)
           
 void setShowHeaders(boolean value)
           
 void setShowInteractive(boolean value)
           
 void setShowOrder(boolean value)
           
 void setShowRulers(boolean value)
           
 void setUseComponentColor(boolean value)
           
 void setUseLastFormat(boolean value)
           
 void setViewMode(StiViewMode value)
           
 void setZoom(double value)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StiDesignerInfo

public StiDesignerInfo()
Creates a new object of the type StiDesignerInfo.


StiDesignerInfo

public StiDesignerInfo(StiReport report)
Creates a new object of the type StiDesignerInfo.

Parameters:
report - Report are these parameters belong to.
Method Detail

getAlignToGrid

public final boolean getAlignToGrid()
Gets or sets value, indicates that components are to be aligned to grid.


getAutoSaveInterval

public final int getAutoSaveInterval()

getAutoSaveReportToReportClass

public final boolean getAutoSaveReportToReportClass()

getCurrentAction

public final StiAction getCurrentAction()
Currect action in designer.


getDrawEventMarkers

public final boolean getDrawEventMarkers()

getDrawMarkersWhenMoving

public final boolean getDrawMarkersWhenMoving()

getEnableAutoSaveMode

public final boolean getEnableAutoSaveMode()

getFillBands

public final boolean getFillBands()
Gets or sets value, indicates that bands are to be filled when drawing them in the designer.


getFillComponent

public final boolean getFillComponent()
Gets or sets value indicates that it is necessary to fill components when drawing them in the designer.


getFillContainer

public final boolean getFillContainer()
Gets or sets value indicates that it is necessary to fill containers when drawing them in the designer.


getFillCrossBands

public final boolean getFillCrossBands()
Gets or sets value, indicates that cross-bands are to be filled when drawing them in the designer.


getForceDesigningMode

public final boolean getForceDesigningMode()
Temporarily sets mode of the designing of components.


getGenerateLocalizedName

public final boolean getGenerateLocalizedName()

getGridMode

public final StiGridMode getGridMode()
Gets or sets grid mode.


getGridSizeCentimetres

public final double getGridSizeCentimetres()
Gets or sets grid size in centimeters.


getGridSizeHundredthsOfInch

public final double getGridSizeHundredthsOfInch()
Gets or sets grid size in hundredths of inch.


getGridSizeInch

public final double getGridSizeInch()
Gets or sets grid size in inches.


getGridSizeMillimeters

public final double getGridSizeMillimeters()
Gets or sets grid size in millimeters.


getGridSizePixels

public final double getGridSizePixels()
Gets or sets grid size in pixels.


getIsComponentsMoving

public final boolean getIsComponentsMoving()

getIsTableMode

public final boolean getIsTableMode()

getMarkersStyle

public final StiMarkersStyle getMarkersStyle()

getQuickInfoOverlay

public final boolean getQuickInfoOverlay()

getQuickInfoType

public final StiQuickInfoType getQuickInfoType()

getReport

public final StiReport getReport()
Gets or sets the report to which these parameters belong.


getRunDesignerAfterInsert

public final boolean getRunDesignerAfterInsert()
Gets or sets value, indicates that it is necessary to run the component designer after the component has been created.


getShowDimensionLines

public final boolean getShowDimensionLines()

getShowGrid

public final boolean getShowGrid()
Gets or sets value indicates that it is necessary to show grid on a page.


getShowHeaders

public final boolean getShowHeaders()
Gets or sets value, indicates that component headers are to be shown from components.


getShowInteractive

public final boolean getShowInteractive()

getShowOrder

public final boolean getShowOrder()
Gets or sets value, indicates that order of components is to be shown on the page.


getShowRulers

public final boolean getShowRulers()
Gets or sets value, indicates that it is necessary to show rulers.


getUseComponentColor

public final boolean getUseComponentColor()
Gets or sets value indicates that, when filling components, use colors in the designer parameters.


getUseLastFormat

public final boolean getUseLastFormat()
Gets or sets value, indicates that format from last selected component copy to new components.


getViewMode

public final StiViewMode getViewMode()
Gets or sets the view mode of a page.


getZoom

public final double getZoom()
Gets or sets zoom of a report (1 = 100%).


setAlignToGrid

public final void setAlignToGrid(boolean value)

setAutoSaveInterval

public final void setAutoSaveInterval(int value)

setAutoSaveReportToReportClass

public final void setAutoSaveReportToReportClass(boolean value)

setCurrentAction

public final void setCurrentAction(StiAction value)

setDrawEventMarkers

public final void setDrawEventMarkers(boolean value)

setDrawMarkersWhenMoving

public final void setDrawMarkersWhenMoving(boolean value)

setEnableAutoSaveMode

public final void setEnableAutoSaveMode(boolean value)

setFillBands

public final void setFillBands(boolean value)

setFillComponent

public final void setFillComponent(boolean value)

setFillContainer

public final void setFillContainer(boolean value)

setFillCrossBands

public final void setFillCrossBands(boolean value)

setForceDesigningMode

public final void setForceDesigningMode(boolean value)

setGenerateLocalizedName

public final void setGenerateLocalizedName(boolean value)

setGridMode

public final void setGridMode(StiGridMode value)

setGridSizeCentimetres

public final void setGridSizeCentimetres(double value)

setGridSizeHundredthsOfInch

public final void setGridSizeHundredthsOfInch(double value)

setGridSizeInch

public final void setGridSizeInch(double value)

setGridSizeMillimeters

public final void setGridSizeMillimeters(double value)

setGridSizePixels

public final void setGridSizePixels(double value)

setIsComponentsMoving

public final void setIsComponentsMoving(boolean value)

setIsTableMode

public final void setIsTableMode(boolean value)

setMarkersStyle

public final void setMarkersStyle(StiMarkersStyle value)

setQuickInfoOverlay

public final void setQuickInfoOverlay(boolean value)

setQuickInfoType

public final void setQuickInfoType(StiQuickInfoType value)

setReport

public final void setReport(StiReport value)

setRunDesignerAfterInsert

public final void setRunDesignerAfterInsert(boolean value)

setShowDimensionLines

public final void setShowDimensionLines(boolean value)

setShowGrid

public final void setShowGrid(boolean value)

setShowHeaders

public final void setShowHeaders(boolean value)

setShowInteractive

public final void setShowInteractive(boolean value)

setShowOrder

public final void setShowOrder(boolean value)

setShowRulers

public final void setShowRulers(boolean value)

setUseComponentColor

public final void setUseComponentColor(boolean value)

setUseLastFormat

public final void setUseLastFormat(boolean value)

setViewMode

public final void setViewMode(StiViewMode value)

setZoom

public final void setZoom(double value)

getGridSize

public double getGridSize()

getPageZoom

public double getPageZoom()
Returns:
the pageZoom

setPageZoom

public void setPageZoom(double pageZoom)
Parameters:
pageZoom - the pageZoom to set

isBookmarked

public java.lang.Boolean isBookmarked(StiComponent component)

getBookmarkComponent

public StiComponent getBookmarkComponent()
Returns:
the bookmarkComponent

setBookmarkComponent

public void setBookmarkComponent(StiComponent bookmarkComponent)
Parameters:
bookmarkComponent - the bookmarkComponent to set

isExporting

public boolean isExporting()
Returns:
the exporting

setExporting

public void setExporting(boolean exporting)
Parameters:
exporting - the exporting to set