com.stimulsoft.report.engine.engineV2
Class StiColumnsContainer

java.lang.Object
  extended by com.stimulsoft.base.serializing.StiSerializedObject
      extended by com.stimulsoft.base.services.StiService
          extended by com.stimulsoft.report.StiBase
              extended by com.stimulsoft.report.components.StiComponent
                  extended by com.stimulsoft.report.components.complexcomponents.StiContainer
                      extended by com.stimulsoft.report.engine.engineV2.StiColumnsContainer
All Implemented Interfaces:
IStiAppExpressionCollection, IStiJsonReportObject, IStiForceSerializable, IStiSerializable, IStiSerializableRef, IStiSerializableToAttributes, IStiName, IStiBorder, IStiBreakable, IStiBrush, IStiCanGrow, IStiCanShrink, IStiComponentGuid, IStiConditions, IStiGrowToHeight, IStiInteraction, IStiPrintOn, IStiSelect, IStiShift, IStiUnitConvert, IStiReportProperty, IStiIgnoryStyle, IStiInherited, IStiStateSaveRestore, java.lang.Cloneable

public class StiColumnsContainer
extends StiContainer

A class describes a container which contains databands. These databands are output in the column mode on the databand.


Field Summary
 StiColumnDirection ColumnDirection
           
 double ColumnGaps
           
 int Columns
           
 double ColumnWidth
           
 int MinRowsInColumn
           
 boolean RightToLeft
           
 
Fields inherited from class com.stimulsoft.report.components.complexcomponents.StiContainer
border, brush, collapsingIndex, components, ParentComponentIsBand, ParentComponentIsCrossBand
 
Fields inherited from class com.stimulsoft.report.components.StiComponent
canGrow, canShrink, componentPlacement, conditions, currentPointer, expressions, interaction, isRendered, page, parent, parentBookmark, parentPointer, top, width
 
Fields inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef
REFERENCE_EMPTY, REFERENCE_REPORT
 
Constructor Summary
StiColumnsContainer()
          Need remove.
StiColumnsContainer(StiEngine engine)
           
 
Method Summary
 void AddContainer(StiContainer container)
          Adds a specified container into the container of columns.
 double FinishColumns()
          Finishes column formation in the container of columns.
 int GetCurrentColumn()
          Returns the number of a column on the current moment.
 int GetLengthOfLastRow()
          Returns the number of output databands in the last row.
 double HowMuchAdditionalSpaceNeeded(double currentHeight, StiContainer container)
          Returns the height of space to place a container into the current container of colimns.
 
Methods inherited from class com.stimulsoft.report.components.complexcomponents.StiContainer
AlignTo, AlignToGrid, AlignToGrid, Break, BringToFront, ChangePosition, checkLargeHeight, ClearAllStates, clone, clone, ContainerToPage, ContainerToPage, convert, Convert, ConvertSelectedToPage, ConvertToPage, Correct, Correct, correct2, getActualSize, getActualSize, getBorder, GetBorder, getBrush, GetBrush, getCanBreak, getClientRectangle, getCollapsedValue, getCollapsingIndex, getCollapsingTreePath, getComponentPlacementForChildren, getComponents, GetComponents, GetComponentsCount, GetComponentsList, getComponentsSelectedRectangle, getComponentStyle, getComponentType, GetConditions, getContainerInfoV1, getContainerInfoV2, GetContainerInRect, GetContainerInRect2, getDefaultClientRectangle, GetDockableComponent, GetDockStyle, GetFirstSelectableCompanent, GetFont, getGuid, getHasSelected, GetHorAlignment, GetIncorrect, GetIncorrect, getIncorrect2, getLocalizedCategory, getLocalizedName, GetMaxSize, getName, getPriority, GetRectangle, GetSelectedComponents, GetSelectedComponentsWithChilds, GetSelectedRectangleWithChilds, getTagValue, GetTextBrush, GetTextFormat, GetTextHorAlignment, getToolboxPosition, GetVertAlignment, GetWordWrap, GrowFont, InvertComponentsPosition, isForceSerializeToReport, LoadFromJsonObject, MakeHorizontalSpacingEqual, MakeSameHeight, MakeSameSize, MakeSameWidth, MakeVerticalSpacingEqual, MoveBackward, MoveComponentsToPage, MoveForward, Normalize, OffsetLocation, PageToContainer, PageToContainer, RemoveAllSelected, ResetSelection, RestoreState, saveState, SaveToJsonObject, SelectAll, SelectComponent, SelectInRectangle, SelectInRectangleCheckBands, SendToBack, setBlocked, setBorder, SetBorder, setBrush, SetBrush, setCanBreak, SetCenterHorizontally, SetCenterVertically, setCollapsedValue, setCollapsingIndex, setCollapsingTreePath, setComponents, setComponentsFont, setComponentsFont, setComponentsWithSetParent, setComponentsWordWrap, SetConditions, setContainerInfoV2, SetDockStyle, setForceSerializeToReport, SetHorAlign, SetLink, setParentComponentIsBand, setParentComponentIsCrossBand, SetParentStylesToChilds, SetParentStylesToChilds, SetTextBrush, SetTextFormat, SetTextHorAlign, SetVertAlign, ShrinkFont, SortByPriority
 
Methods inherited from class com.stimulsoft.report.components.StiComponent
addSize, applyConditions, canContainIn, CheckForParentComponent, clearAllStates, ClearContents, clone, ComponentToPage, ComponentToPage, ComponentToPage, convert, decrementTop, doBookmark, DoBookmark, DockToContainer, DockToContainer, doGetBookmark, DoOffsetRect, doPointer, fillComponentPlacement, getAfterPrintEvent, getAlias, getAllowDelete, getAnchor, getBeforePrintEvent, getBookmark, getBookmarkValue, getBottom, getCanGrow, getCanShrink, getClickEvent, getComponentPlacement, getConditions, getContainer, getCurrentBookmark, getDataBand, GetDataBand, getDelimiterComponent, getDisplayRectangle, getDisplayRectangle1, getDockable, getDockRegion, getDockRegion, getDockStyle, getDoubleClickEvent, getDrillDownParameters, getEnabled, getEvents, getExpressions, getForceRedrawAll, getgetBookmarkEvent, getgetDrillDownReportEvent, getgetHyperlinkEvent, getgetTagEvent, getgetToolTipEvent, getGroupHeaderBand, GetGroupHeaderBand, getGrowToHeight, getHeight, getHighlightState, getHyperlink, getHyperlinkValue, getIgnoreNamingRule, getImage, getImage, getInherited, getInteraction, getInvalidateOnMouseOver, getIsCross, getIsDesigning, getIsEnabled, getIsEventEmpty, getIsExporting, getIsgetTagHandlerEmpty, getIsPrinting, getIsRendered, getIsSelected, getLeft, getLevel, getLinked, getLocked, getMaxSize, getMeasureGraphics, getMinSize, getMouseEnterEvent, getMouseLeaveEvent, getPage, getPaintRectangle, getPaintRectangle, getPaintRectangle, getParent, getParentBookmark, getPlaceOnToolbox, getPointer, getPointerValue, getPrintable, getPrintOn, getQuickInfo, getRenderedCount, getReport, getRestrictions, getRight, getSelectionTick, getSelectRectangle, getServiceCategory, getServiceType, getShift, getShiftMode, getShowQuickButtons, getTag, getTagStrValue, getToolTip, getToolTipValue, getTop, getUseParentStyles, getWidth, incrementtTop, InternalRender, invert, InvokeAfterPrint, InvokeBeforePrint, InvokeBeginRender, InvokeClick, InvokeDoubleClick, InvokeEndRender, invokeEvents, InvokegetBookmark, InvokegetDrillDownReport, InvokegetHyperlink, InvokegetTag, InvokegetToolTip, InvokeMouseEnter, InvokeMouseLeave, InvokePainted, invokePainting, isAutomaticDock, isDesigning, isExportAsImage, IsParentSelect, NewGuid, OnRemoveComponent, packService, PageToComponent, PageToComponent, paint, PlacedOnColumnBand, Prepare, render, reset, Reset, restoreState, select, setAfterPrintEvent, setAlias, setAnchor, setBeforePrintEvent, setBookmark, setBookmarkValue, setCanGrow, setCanShrink, setClickEvent, setClientRectangle, setComponentPlacement, setComponentStyle, setConditions, setCurrentBookmark, setDelimiterComponent, setDirectDisplayRectangle, setDisplayRectangle, setDockable, setDockStyle, setDoubleClickEvent, setDrillDownParameters, setEnabled, setExpressions, setgetBookmarkEvent, setgetDrillDownReportEvent, setgetHyperlinkEvent, setgetTagEvent, setgetToolTipEvent, setGrowToHeight, setGuid, setHeight, setHeightProp, setHighlightState, setHyperlink, setHyperlinkValue, setIgnoreNamingRule, setInherited, setInteraction, setIsRendered, setIsSelected, setLeft, setLeftProp, setLinked, setLocked, setMaxSize, setMinSize, setMouseEnterEvent, setMouseLeaveEvent, setName, setPage, setPaintRectangle, setParent, setParentBookmark, setPlaceOnToolbox, setPointer, setPointerValue, setPrintable, setPrintOn, setRenderedCount, setReport, SetReportVariables, setRestrictions, setSelectionTick, setSelectRectangle, setShift, setShiftMode, setShowQuickButtons, setStates, setTag, setTagValue, setToolTip, setToolTipValue, setTop, setTopProp, setUseParentStyles, setWidth, setWidthProp, toString, UnPrepare
 
Methods inherited from class com.stimulsoft.report.StiBase
getServiceName
 
Methods inherited from class com.stimulsoft.base.services.StiService
getProperties, getServiceEnabled, getServiceInfo, isPropertyPresent, MemberwiseClone, properties, setProperties, setServiceEnabled
 
Methods inherited from class com.stimulsoft.base.serializing.StiSerializedObject
cleanReference, getReference, setReference
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef
getReference, setReference
 

Field Detail

Columns

public int Columns

ColumnWidth

public double ColumnWidth

ColumnGaps

public double ColumnGaps

ColumnDirection

public StiColumnDirection ColumnDirection

RightToLeft

public boolean RightToLeft

MinRowsInColumn

public int MinRowsInColumn
Constructor Detail

StiColumnsContainer

public StiColumnsContainer(StiEngine engine)

StiColumnsContainer

public StiColumnsContainer()
Need remove.

Method Detail

AddContainer

public final void AddContainer(StiContainer container)
Adds a specified container into the container of columns. The CountOfItems field is increased on 1.

Parameters:
container - A container that should be added.

HowMuchAdditionalSpaceNeeded

public final double HowMuchAdditionalSpaceNeeded(double currentHeight,
                                                 StiContainer container)
Returns the height of space to place a container into the current container of colimns.

Parameters:
currentHeight - Current height of the container of columns.
container - A container that will be placed in the container of columns.
Returns:
Necessary space.

FinishColumns

public final double FinishColumns()
Finishes column formation in the container of columns. All containers are placed on their proper places.

Returns:
Returns the maximal height

GetCurrentColumn

public final int GetCurrentColumn()
Returns the number of a column on the current moment. The number starts with 1. For the DownThenAcross 1 is always returned.

Returns:
The number of an output column.

GetLengthOfLastRow

public final int GetLengthOfLastRow()
Returns the number of output databands in the last row. The method can be used only for the AcrossThenDown mode.

Returns:
The number of output databands