StiContainer (stimulsoft.reports report 2019.3.5 API)

java.lang.Object
- com.stimulsoft.base.serializing.StiSerializedObject
- - com.stimulsoft.base.services.StiService
  - - com.stimulsoft.report.StiBase
    - - com.stimulsoft.report.components.StiComponent
      - com.stimulsoft.report.components.complexcomponents.StiContainer

All Implemented Interfaces:

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

Direct Known Subclasses:

StiBand, StiClone, StiColumnsContainer, StiCrossTab, StiFooterMarkerContainer, StiLevelContainer, StiNewPageContainer, StiPanel, StiReportControl, StiSubReport
```
public class StiContainer
extends StiComponent
implements IStiBorder, IStiBrush, IStiBreakable, IStiIgnoryStyle, IStiSerializableToAttributes, IStiForceSerializable
```

Field Summary

Fields
Modifier and Type	Field and Description
`StiBorder`	`border`
`StiBrush`	`brush`
`int`	`collapsingIndex`
`StiComponentsCollection`	`components`
`boolean`	`ParentComponentIsBand` Если true, то Parent компонент этого контейнера является Band.
`boolean`	`ParentComponentIsCrossBand` Если true, то Parent компонент этого контейнера является CrossBand.
`protected static java.lang.Object`	`PropertyBlocked`

Fields inherited from class com.stimulsoft.report.components.StiComponent
canGrow, canShrink, componentPlacement, conditions, interaction, isRendered, page, parent, parentBookmark, PropertyComponentStyle, PropertyDelimiterComponent, PropertyDockable, PropertyInherited, PropertyLinked, PropertyLocked, PropertyMaxSize, PropertyMinSize, PropertyPlaceOnToolbox, PropertyRenderedCount, PropertyRestrictions, PropertySelectionTick, PropertyShowQuickButtons, PropertyUseParentStyles, top, width

Fields inherited from class com.stimulsoft.base.services.StiService
properties

Fields inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef
REFERENCE_EMPTY, REFERENCE_REPORT

Constructor Summary

Constructors
Constructor and Description

StiContainer()
Creates a new container.

StiContainer(StiRectangle rect)
Creates a new container.

Constructors
Constructor and Description
`StiContainer()` Creates a new container.
`StiContainer(StiRectangle rect)` Creates a new container.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`AlignTo(StiAligning aligning)` Aligns, in the rectangle of selected objects, all selected objects.
`void`	`AlignToGrid()` Aligns to grid all selected components in the container.
`void`	`AlignToGrid(StiComponent comp)`
`boolean`	`Break(StiComponent dividedComponent, double devideFactor, StiRefObject<java.lang.Double> divideLine)` Divides content of components in two parts.
`void`	`BringToFront()` Brings to front objects of the list in the container.
`void`	`ChangePosition(StiRectangle delta)` Changes the position of the selected component.
`protected void`	`checkBlockedException(java.lang.String propertyName)`
`protected void`	`CheckBlockedException(java.lang.String propertyName)`
`void`	`checkLargeHeight(boolean needFullCalculation)`
`void`	`ClearAllStates()` Clear all earlier saved object states.
`java.lang.Object`	`clone(boolean cloneProperties)` Creates a new object that is a copy of the current instanc.
`java.lang.Object`	`clone(boolean cloneProperties, boolean cloneComponents)` Creates a new object that instanceof a copy of the current instance.
`StiPoint`	`ContainerToPage(StiPoint point)` Converts a point of coordinates of the container into coodinates of a page.
`StiRectangle`	`ContainerToPage(StiRectangle rect)` Converts a rectangle from container coordinates into coordinates of a page.
`void`	`convert(StiUnit oldUnit, StiUnit newUnit)` Converts a component out of one unit into another.
`void`	`Convert(StiUnit oldUnit, StiUnit newUnit, boolean convertComponents)` Converts a component out of one unit into another.
`void`	`ConvertSelectedToPage()` Converts coordinates of all objects into coordinates of a page.
`void`	`ConvertToPage()` Converts objects from all coordinates into coordinates of a page without move them on a page.
`void`	`Correct()` Corrects in the container all objects which require motion between containers.
`void`	`Correct(boolean onlySelect)` Corrects in container all objects which require moving.
`void`	`correct2(boolean onlySelect)`
`StiSize`	`getActualSize()` Initializes a new instance of the StiSize class from the specified dimensi.
`StiSize`	`getActualSize(boolean isFirstPass, StiRefObject<java.lang.Boolean> needSecondPass)`
`protected boolean`	`getBlocked()` Internal use only.
`StiBorder`	`getBorder()` Gets or sets frame of the component.
`java.lang.Object`	`GetBorder()` Returns a frame of the object of the type IStiBorder being met first.
`StiBrush`	`getBrush()` Gets or sets a brush to fill a component.
`java.lang.Object`	`GetBrush()` Returns a brush of an object of the type StiBrush being met first.
`boolean`	`getCanBreak()` Gets or sets value which indicates whether the component can or cannot break its contents on several pages.
`StiRectangle`	`getClientRectangle()` gets or sets the client area of a component.
`java.lang.Object`	`getCollapsedValue()` Gets or sets collapsed value of the component.
`int`	`getCollapsingIndex()`
`java.lang.String`	`getCollapsingTreePath()`
`java.lang.String`	`getComponentPlacementForChildren()`
`StiComponentsCollection`	`getComponents()` Gets or sets a collection of components.
`StiComponentsCollection`	`GetComponents()` Returns the list of all components which are located in the container.
`int`	`GetComponentsCount()`
`java.util.ArrayList<StiComponent>`	`GetComponentsList()` Returns the list of all components which are located in the container.
`StiRectangle`	`getComponentsSelectedRectangle()` Returns the rectangle that includes all selected objects in the container.
`java.lang.String`	`getComponentStyle()` gets or sets a style of a component.
`StiComponentType`	`getComponentType()` Gets the type of processing when printing.
`StiConditionsCollection`	`GetConditions()` Returns conditions of an object of the type.
`StiContainerInfoV1`	`getContainerInfoV1()`
`StiContainerInfoV2`	`getContainerInfoV2()`
`StiContainer`	`GetContainerInRect(StiRectangle rect, StiComponent component)` Returns an container in which client zone coordinates are got.
`StiContainer`	`GetContainerInRect2(StiRectangle rect, StiComponent component, java.util.HashMap hash)`
`StiRectangle`	`getDefaultClientRectangle()` Gets or sets the default client area of a component.
`StiComponent`	`GetDockableComponent()` Returns the first docked and selected component.
`java.lang.Object`	`GetDockStyle()` Returns the style of docking of the component being met first.
`StiComponent`	`GetFirstSelectableCompanent()` Returns the first selected component.
`java.lang.Object`	`GetFont()` Returns a font of an object of the type IStiFont being met first.
`java.lang.String`	`getGuid()` gets or sets a guid of component.
`boolean`	`getHasSelected()` Internal use only.
`java.lang.Object`	`GetHorAlignment()` Returns a horizontal alignment of the object of the type IStiHorAlignment being met first.
`StiComponentsCollection`	`GetIncorrect()` Returns the list of all objects which require motion between containers.
`StiComponentsCollection`	`GetIncorrect(boolean onlySelect)` Returns the list of all objects which require motion between containers.
`StiComponentsCollection`	`getIncorrect2(boolean onlySelect)`
`java.lang.String`	`getLocalizedCategory()` Gets a localized name of the component category.
`java.lang.String`	`getLocalizedName()` Gets a localized component name.
`StiSize`	`GetMaxSize()` Returns maximum sizes among selected objects.
`java.lang.String`	`getName()` Gets or sets a component name.
`int`	`getPriority()` Gets a component priority.
`StiRectangle`	`GetRectangle()` The rectangle includes all selected objects in the container.
`StiComponentsCollection`	`GetSelectedComponents()` Returns the array of the selected components.
`StiComponentsCollection`	`GetSelectedComponentsWithChilds()` Returns the array of the selected objects including child of the selected objects.
`StiRectangle`	`GetSelectedRectangleWithChilds()` The rectangle includes all selected objects in the container and children containers which are located in the selected containers.
`java.lang.String`	`getTagValue()` gets or sets tag of a component.
`java.lang.Object`	`GetTextBrush()` Returns a brush of an object of the type IStiTextBrush being met first.
`StiFormatService`	`GetTextFormat()` Returns a format of an object of the type IStiText being met first.
`java.lang.Object`	`GetTextHorAlignment()` Returns a horizontal alignment of an object of the type IStiTextHorAlignment being met first.
`int`	`getToolboxPosition()` Gets value to sort a position in the toolbox.
`java.lang.Object`	`GetVertAlignment()` Returns a vertical alignment of the object of the type IStiVertAlignment being met first.
`java.lang.Object`	`GetWordWrap()`
`void`	`GrowFont()`
`void`	`InvertComponentsPosition()`
`boolean`	`isForceSerializeToReport()`
`void`	`LoadFromJsonObject(JSONObject jObject)`
`void`	`MakeHorizontalSpacingEqual()` Puts components which are equivalent to their width.
`void`	`MakeSameHeight(double height)` Sets the height to all selected objects.
`void`	`MakeSameSize(StiSize size)` Sets the size to all selected objects.
`void`	`MakeSameWidth(double width)` Sets the width to all selected objects.
`void`	`MakeVerticalSpacingEqual()` Puts components which are equal in their height.
`void`	`MoveBackward()` Moves backward objects of the list in the container.
`void`	`MoveComponentsToPage()` Converts coordinates of all objects into coordinates of a page and moves objects on the page.
`void`	`MoveForward()` Moves forward objects of the list in the container.
`void`	`Normalize()` Normalizes all selected objects in the container.
`void`	`OffsetLocation(double offsetX, double offsetY)`
`protected void`	`OnComponentAdded(StiEventHandlerArgs e)`
`protected void`	`OnComponentRemoved(StiEventHandlerArgs e)`
`StiPoint`	`PageToContainer(StiPoint point)` Converts a point of coordinates of a page into coodinates of a container.
`StiRectangle`	`PageToContainer(StiRectangle rectIn)` Converts a rectangle from coordinates of a page into container coordinates.
`void`	`RemoveAllSelected()` Removes all selected object from the container.
`void`	`ResetSelection()` Resets selection from all selected objects in the container.
`void`	`RestoreState(java.lang.String stateName)` Restores the earlier saved object state.
`void`	`saveState(java.lang.String stateName)` Saves the current state of an object.
`JSONObject`	`SaveToJsonObject(StiJsonSaveMode mode)`
`void`	`SelectAll()` Select all components in container.
`void`	`SelectComponent(StiComponent component)` Selects the specified component in the container.
`void`	`SelectInRectangle(StiRectangle rect)` Selects all objects in the container which intersect with the specified rectangle.
`void`	`SelectInRectangleCheckBands(StiRectangle rect)`
`void`	`SendToBack()` Sends to back objects of the list in the container.
`void`	`setBlocked(boolean value)`
`void`	`setBorder(StiBorder value)`
`void`	`SetBorder(StiBorder border)` Sets StiBorder from all selected objects in the container.
`void`	`setBrush(StiBrush value)`
`void`	`SetBrush(StiBrush brush)` Sets IStiBrush from all selected objects in the container.
`void`	`setCanBreak(boolean value)`
`void`	`SetCenterHorizontally()` Centers horizontally all selected objects.
`void`	`SetCenterVertically()` Centers vertically all selected objects.
`void`	`setCollapsedValue(java.lang.Object value)`
`void`	`setCollapsingIndex(int value)`
`void`	`setCollapsingTreePath(java.lang.String collapsingTreePath)`
`void`	`setComponents(StiComponentsCollection value)`
`void`	`setComponentsFont(StiFont font)`
`void`	`setComponentsFont(StiFont font, boolean setFontFamily, boolean setSize, boolean setStyleBold, boolean setStyleItalic, boolean setStyleUnderline, boolean setStyleStrikeout, boolean setUnit, boolean setGdiCharSet, boolean setGdiVerticalFont)` Sets IStiFont from all selected objects in the container.
`void`	`setComponentsWithSetParent(StiComponentsCollection components)`
`void`	`setComponentsWordWrap(boolean wordWrap)`
`void`	`SetConditions(StiConditionsCollection conditions)` Sets conditions to all selected objects in the container.
`void`	`setContainerInfoV2(StiContainerInfoV2 containerInfoV2)`
`void`	`SetDockStyle(StiDockStyle dockStyle)` Sets Dock from all selected objects in the container.
`void`	`setForceSerializeToReport(boolean forceSerializeToReport)`
`void`	`SetHorAlign(StiHorAlignment vl)` Sets StiHorAlignment from all selected objects in the container.
`void`	`SetLink(boolean linked)` Sets Link from all selected objects in the container.
`void`	`setParentComponentIsBand(boolean value)`
`void`	`setParentComponentIsCrossBand(boolean value)`
`void`	`SetParentStylesToChilds()`
`void`	`SetParentStylesToChilds(StiBaseStyle style)`
`void`	`SetTextBrush(StiBrush brush)` Sets IStiTextBrush from all selected objects in the container.
`void`	`SetTextFormat(StiFormatService format)` Sets StiFormatService from all selected objects in the container.
`void`	`SetTextHorAlign(StiTextHorAlignment vl)` Sets StiTextHorAlignment from all selected objects in the container.
`void`	`SetVertAlign(StiVertAlignment vl)` Sets StiVertAlignment from all selected objects in the container.
`void`	`ShrinkFont()`
`void`	`SortByPriority()`

Methods inherited from class com.stimulsoft.report.components.StiComponent
addSize, AllowPrintOn, applyConditions, canContainIn, CheckForParentComponent, clearAllStates, ClearContents, clone, ComponentToPage, ComponentToPage, ComponentToPage, convert, decrementTop, doBookmark, DoBookmark, DockToContainer, DockToContainer, doGetBookmark, DoOffsetRect, fillComponentPlacement, getAfterPrintEvent, getAlias, getAllowDelete, getAnchor, getBeforePrintEvent, getBookmark, getBookmarkValue, getBottom, getBuilder, getCanGrow, getCanShrink, getClickEvent, getComponentPlacement, getConditions, getContainer, getCurrentBookmark, getDataBand, GetDataBand, getDelimiterComponent, getDisplayRectangle, getDisplayRectangle1, getDockable, getDockRegion, getDockRegion, getDockStyle, getDoubleClickEvent, getDrillDownParameters, getEnabled, getEvents, 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, getPrintable, getPrintOn, getQuickInfo, getRenderedCount, getReport, getRestrictions, getRight, getSelectionTick, getSelectRectangle, getServiceCategory, getServiceType, getShift, getShiftMode, getShowQuickButtons, getStates, getTag, 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, OnAfterPrint, OnBeforePrint, OnClick, OnDoubleClick, OngetBookmark, OngetDrillDownReport, OngetHyperlink, OngetTag, OngetToolTip, OnMouseEnter, OnMouseLeave, OnPainted, OnPainting, 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, 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, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef
getReference, setReference

- Field Detail
  - border
```
public StiBorder border
```
  - brush
```
public StiBrush brush
```
  - ParentComponentIsBand
```
public boolean ParentComponentIsBand
```
    Если true, то Parent компонент этого контейнера является Band.
  - ParentComponentIsCrossBand
```
public boolean ParentComponentIsCrossBand
```
    Если true, то Parent компонент этого контейнера является CrossBand.
  - collapsingIndex
```
public int collapsingIndex
```
  - components
```
public StiComponentsCollection components
```
  - PropertyBlocked
```
protected static java.lang.Object PropertyBlocked
```
- Constructor Detail
  - StiContainer
```
public StiContainer()
```
    Creates a new container.
  - StiContainer
```
public StiContainer(StiRectangle rect)
```
    Creates a new container.
    
    Parameters:
    rect - The rectangle describes size and position of the container.
- Method Detail
  - SaveToJsonObject
```
public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException
```
    Specified by:
    
    SaveToJsonObject in interface IStiJsonReportObject
    
    Overrides:
    
    SaveToJsonObject in class StiComponent
    
    Throws:
    
    JSONException
  - LoadFromJsonObject
```
public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException
```
    Specified by:
    
    LoadFromJsonObject in interface IStiJsonReportObject
    
    Overrides:
    
    LoadFromJsonObject in class StiComponent
    
    Throws:
    
    JSONException
  - isForceSerializeToReport
```
public boolean isForceSerializeToReport()
```
    Specified by:
    
    isForceSerializeToReport in interface IStiForceSerializable
    
    Returns:
    the forceSerializeToReport
  - setForceSerializeToReport
```
public void setForceSerializeToReport(boolean forceSerializeToReport)
```
    Specified by:
    
    setForceSerializeToReport in interface IStiForceSerializable
    
    Parameters:
    forceSerializeToReport - the forceSerializeToReport to set
  - getCanBreak
```
public boolean getCanBreak()
```
    Gets or sets value which indicates whether the component can or cannot break its contents on several pages.
    
    Specified by:
    
    getCanBreak in interface IStiBreakable
  - getCollapsingTreePath
```
public java.lang.String getCollapsingTreePath()
```
    Returns:
    the collapsingTreePath
  - setCollapsingTreePath
```
public void setCollapsingTreePath(java.lang.String collapsingTreePath)
```
    Parameters:
    collapsingTreePath - the collapsingTreePath to set
  - setCanBreak
```
public void setCanBreak(boolean value)
```
    Specified by:
    
    setCanBreak in interface IStiBreakable
  - Break
```
public boolean Break(StiComponent dividedComponent,
            double devideFactor,
            StiRefObject<java.lang.Double> divideLine)
```
    Divides content of components in two parts. Returns result of dividing. If true, then component instanceof successful divided.
    
    Specified by:
    
    Break in interface IStiBreakable
    
    Parameters:
    dividedComponent - Component for store part of content.
    
    Returns:
    If true, then component instanceof successful divided.
  - clone
```
public java.lang.Object clone(boolean cloneProperties)
```
    Description copied from class: StiComponent
    
    Creates a new object that is a copy of the current instanc.
    
    Overrides:
    
    clone in class StiComponent
    
    Returns:
    A new object that is a copy of this instance.
  - clone
```
public java.lang.Object clone(boolean cloneProperties,
                     boolean cloneComponents)
```
    Creates a new object that instanceof a copy of the current instance.
    
    Returns:
    A new object that instanceof a copy of this instance.
  - getBorder
```
public StiBorder getBorder()
```
    Gets or sets frame of the component.
    
    Specified by:
    
    getBorder in interface IStiBorder
  - setBorder
```
public void setBorder(StiBorder value)
```
    Specified by:
    
    setBorder in interface IStiBorder
  - getBrush
```
public StiBrush getBrush()
```
    Gets or sets a brush to fill a component.
    
    Specified by:
    
    getBrush in interface IStiBrush
  - setBrush
```
public void setBrush(StiBrush value)
```
    Specified by:
    
    setBrush in interface IStiBrush
  - saveState
```
public void saveState(java.lang.String stateName)
```
    Saves the current state of an object.
    
    Specified by:
    
    saveState in interface IStiStateSaveRestore
    
    Overrides:
    
    saveState in class StiComponent
    
    Parameters:
    stateName - A name of the state being saved.
  - RestoreState
```
public void RestoreState(java.lang.String stateName)
```
    Restores the earlier saved object state.
    
    Overrides:
    
    RestoreState in class StiComponent
    
    Parameters:
    stateName - A name of the state being restored.
  - ClearAllStates
```
public void ClearAllStates()
```
    Clear all earlier saved object states.
    
    Overrides:
    
    ClearAllStates in class StiComponent
  - getActualSize
```
public StiSize getActualSize()
```
    Description copied from class: StiComponent
    
    Initializes a new instance of the StiSize class from the specified dimensi.
    
    Overrides:
    
    getActualSize in class StiComponent
    
    Returns:
    A class of the StiSize type which represents an actual size of the component.
  - getActualSize
```
public final StiSize getActualSize(boolean isFirstPass,
                    StiRefObject<java.lang.Boolean> needSecondPass)
```
  - getContainerInfoV1
```
public final StiContainerInfoV1 getContainerInfoV1()
```
  - getContainerInfoV2
```
public final StiContainerInfoV2 getContainerInfoV2()
```
  - getPriority
```
public int getPriority()
```
    Gets a component priority.
    
    Overrides:
    
    getPriority in class StiComponent
  - getToolboxPosition
```
public int getToolboxPosition()
```
    Gets value to sort a position in the toolbox.
    
    Overrides:
    
    getToolboxPosition in class StiComponent
  - getComponentType
```
public StiComponentType getComponentType()
```
    Gets the type of processing when printing.
    
    Overrides:
    
    getComponentType in class StiComponent
  - getLocalizedCategory
```
public java.lang.String getLocalizedCategory()
```
    Gets a localized name of the component category.
    
    Overrides:
    
    getLocalizedCategory in class StiBase
  - getLocalizedName
```
public java.lang.String getLocalizedName()
```
    Gets a localized component name.
    
    Overrides:
    
    getLocalizedName in class StiBase
  - getCollapsedValue
```
public final java.lang.Object getCollapsedValue()
```
    Gets or sets collapsed value of the component.
  - setCollapsedValue
```
public final void setCollapsedValue(java.lang.Object value)
```
  - getCollapsingIndex
```
public int getCollapsingIndex()
```
  - setCollapsingIndex
```
public void setCollapsingIndex(int value)
```
  - getHasSelected
```
public final boolean getHasSelected()
```
    Internal use only.
  - getDefaultClientRectangle
```
public StiRectangle getDefaultClientRectangle()
```
    Gets or sets the default client area of a component.
    
    Overrides:
    
    getDefaultClientRectangle in class StiComponent
  - getComponents
```
public StiComponentsCollection getComponents()
```
    Gets or sets a collection of components.
  - setComponents
```
public void setComponents(StiComponentsCollection value)
```
  - checkBlockedException
```
protected void checkBlockedException(java.lang.String propertyName)
```
  - CheckBlockedException
```
protected void CheckBlockedException(java.lang.String propertyName)
```
  - getBlocked
```
protected boolean getBlocked()
```
    Internal use only. Это свойство используется для блокирования измнения свойств бэнда, измнение которых во время построения бэнда может исказить результат.
  - setBlocked
```
public void setBlocked(boolean value)
```
  - OnComponentAdded
```
protected void OnComponentAdded(StiEventHandlerArgs e)
```
  - OnComponentRemoved
```
protected void OnComponentRemoved(StiEventHandlerArgs e)
```
  - SetParentStylesToChilds
```
public final void SetParentStylesToChilds()
```
  - SetParentStylesToChilds
```
public final void SetParentStylesToChilds(StiBaseStyle style)
```
  - OffsetLocation
```
public final void OffsetLocation(double offsetX,
                  double offsetY)
```
  - ChangePosition
```
public final void ChangePosition(StiRectangle delta)
```
    Changes the position of the selected component.
    
    Parameters:
    delta - Parameters of changing.
  - Normalize
```
public final void Normalize()
```
    Normalizes all selected objects in the container.
  - SetLink
```
public final void SetLink(boolean linked)
```
    Sets Link from all selected objects in the container.
  - SetBorder
```
public final void SetBorder(StiBorder border)
```
    Sets StiBorder from all selected objects in the container. Sets Side, DropShadow, Color, Style. All other elements are ignored.
  - GetBorder
```
public final java.lang.Object GetBorder()
```
    Returns a frame of the object of the type IStiBorder being met first. Scans all selected objects in the container.
    
    Returns:
    The frame of the object type IStiBorder found. If nothing instanceof found then null instanceof returned.
  - SetVertAlign
```
public final void SetVertAlign(StiVertAlignment vl)
```
    Sets StiVertAlignment from all selected objects in the container.
    
    Parameters:
    vl - StiVertAlignment being set.
  - GetVertAlignment
```
public final java.lang.Object GetVertAlignment()
```
    Returns a vertical alignment of the object of the type IStiVertAlignment being met first. Scans all selected objects in the container.
    
    Returns:
    Vertical alignment of the object of the type IStiVertAlignment found. If nothing instanceof found then null instanceof returned.
  - SetHorAlign
```
public final void SetHorAlign(StiHorAlignment vl)
```
    Sets StiHorAlignment from all selected objects in the container.
    
    Parameters:
    vl - StiHorAlignment being set.
  - GetHorAlignment
```
public final java.lang.Object GetHorAlignment()
```
    Returns a horizontal alignment of the object of the type IStiHorAlignment being met first. Scans all selected objects in the container.
    
    Returns:
    Horizontal alignment of an object of the type IStiHorAlignment found. If nothing instanceof found then null instanceof returned.
  - SetTextHorAlign
```
public final void SetTextHorAlign(StiTextHorAlignment vl)
```
    Sets StiTextHorAlignment from all selected objects in the container.
    
    Parameters:
    vl - StiTextHorAlignment being set.
  - GetTextHorAlignment
```
public final java.lang.Object GetTextHorAlignment()
```
    Returns a horizontal alignment of an object of the type IStiTextHorAlignment being met first. Scans all selected objects in the container.
    
    Returns:
    Horizontal alignment of the object of the type IStiTextHorAlignment found. If nothing instanceof found then null instanceof returned.
  - GetWordWrap
```
public final java.lang.Object GetWordWrap()
```
  - setComponentsWordWrap
```
public final void setComponentsWordWrap(boolean wordWrap)
```
  - setComponentsFont
```
public final void setComponentsFont(StiFont font)
```
  - setComponentsFont
```
public final void setComponentsFont(StiFont font,
                     boolean setFontFamily,
                     boolean setSize,
                     boolean setStyleBold,
                     boolean setStyleItalic,
                     boolean setStyleUnderline,
                     boolean setStyleStrikeout,
                     boolean setUnit,
                     boolean setGdiCharSet,
                     boolean setGdiVerticalFont)
```
    Sets IStiFont from all selected objects in the container.
  - GetFont
```
public final java.lang.Object GetFont()
```
    Returns a font of an object of the type IStiFont being met first. Scans all selected objects in the container.
    
    Returns:
    The font of an object of the type IStiFont found. If nothing instanceof found then null instanceof returned.
  - GrowFont
```
public final void GrowFont()
```
  - ShrinkFont
```
public final void ShrinkFont()
```
  - SetBrush
```
public final void SetBrush(StiBrush brush)
```
    Sets IStiBrush from all selected objects in the container.
  - GetBrush
```
public final java.lang.Object GetBrush()
```
    Returns a brush of an object of the type StiBrush being met first. Scans all selected objects in the container.
    
    Returns:
    The brush of an object of the type IStiBrush found. If nothing instanceof found then null instanceof returned.
  - SetTextFormat
```
public final void SetTextFormat(StiFormatService format)
```
    Sets StiFormatService from all selected objects in the container.
    
    Parameters:
    format - Format being set.
  - GetTextFormat
```
public final StiFormatService GetTextFormat()
```
    Returns a format of an object of the type IStiText being met first. Scans all selected objects in the container.
    
    Returns:
    The format of an object of the type IStiText found. If nothing instanceof found then null instanceof returned.
  - SetTextBrush
```
public final void SetTextBrush(StiBrush brush)
```
    Sets IStiTextBrush from all selected objects in the container.
    
    Parameters:
    brush - TextBrush being set.
  - GetTextBrush
```
public final java.lang.Object GetTextBrush()
```
    Returns a brush of an object of the type IStiTextBrush being met first. Scans all selected objects in the container.
    
    Returns:
    The brush of an object of the type IStiTextBrush found. If nothing instanceof found then null instanceof returned.
  - SetConditions
```
public final void SetConditions(StiConditionsCollection conditions)
```
    Sets conditions to all selected objects in the container.
  - GetConditions
```
public final StiConditionsCollection GetConditions()
```
    Returns conditions of an object of the type. Scans all selected objects in the container.
  - SetDockStyle
```
public final void SetDockStyle(StiDockStyle dockStyle)
```
    Sets Dock from all selected objects in the container.
    
    Parameters:
    dockStyle - DockStyle being set.
  - GetDockStyle
```
public final java.lang.Object GetDockStyle()
```
    Returns the style of docking of the component being met first. Scans all selected objects in the container.
    
    Returns:
    The style of docking of the component found. If nothing instanceof found then null instanceof returned.
  - GetSelectedRectangleWithChilds
```
public final StiRectangle GetSelectedRectangleWithChilds()
```
    The rectangle includes all selected objects in the container and children containers which are located in the selected containers. The rectangle instanceof represented in page coordinates.
    
    Returns:
    The rectangle includes all selected objects.
  - getComponentsSelectedRectangle
```
public final StiRectangle getComponentsSelectedRectangle()
```
    Returns the rectangle that includes all selected objects in the container. The rectangle instanceof represented in page coordinates.
    
    Returns:
    The rectangle includes all selected objects.
  - GetRectangle
```
public final StiRectangle GetRectangle()
```
    The rectangle includes all selected objects in the container. The rectangle instanceof represented in page coordinates.
    
    Returns:
    The rectangle includes all objects.
  - GetMaxSize
```
public final StiSize GetMaxSize()
```
    Returns maximum sizes among selected objects.
    
    Returns:
    Maximum sizes.
  - MakeSameSize
```
public final void MakeSameSize(StiSize size)
```
    Sets the size to all selected objects.
    
    Parameters:
    size - Size to be set.
  - MakeSameWidth
```
public final void MakeSameWidth(double width)
```
    Sets the width to all selected objects.
    
    Parameters:
    width - Width to be set.
  - MakeSameHeight
```
public final void MakeSameHeight(double height)
```
    Sets the height to all selected objects.
    
    Parameters:
    height - Height to be set.
  - MakeHorizontalSpacingEqual
```
public final void MakeHorizontalSpacingEqual()
```
    Puts components which are equivalent to their width.
  - MakeVerticalSpacingEqual
```
public final void MakeVerticalSpacingEqual()
```
    Puts components which are equal in their height.
  - SetCenterHorizontally
```
public final void SetCenterHorizontally()
```
    Centers horizontally all selected objects.
  - SetCenterVertically
```
public final void SetCenterVertically()
```
    Centers vertically all selected objects.
  - AlignToGrid
```
public final void AlignToGrid()
```
    Aligns to grid all selected components in the container.
  - AlignToGrid
```
public final void AlignToGrid(StiComponent comp)
```
  - SortByPriority
```
public final void SortByPriority()
```
  - AlignTo
```
public final void AlignTo(StiAligning aligning)
```
    Aligns, in the rectangle of selected objects, all selected objects.
    
    Parameters:
    aligning - Type of aligning.
  - BringToFront
```
public final void BringToFront()
```
    Brings to front objects of the list in the container.
  - SendToBack
```
public final void SendToBack()
```
    Sends to back objects of the list in the container.
  - MoveForward
```
public final void MoveForward()
```
    Moves forward objects of the list in the container.
  - MoveBackward
```
public final void MoveBackward()
```
    Moves backward objects of the list in the container.
  - GetContainerInRect
```
public final StiContainer GetContainerInRect(StiRectangle rect,
                              StiComponent component)
```
    Returns an container in which client zone coordinates are got.
    
    Parameters:
    x - Coordinate X for checking(coordinates of a page).
    y - Coordinate Y for checking(coordinates of a page).
    component - The component for which positions are being looked for.
  - GetContainerInRect2
```
public StiContainer GetContainerInRect2(StiRectangle rect,
                               StiComponent component,
                               java.util.HashMap hash)
```
  - getIncorrect2
```
public StiComponentsCollection getIncorrect2(boolean onlySelect)
```
  - correct2
```
public void correct2(boolean onlySelect)
```
  - GetIncorrect
```
public final StiComponentsCollection GetIncorrect()
```
    Returns the list of all objects which require motion between containers.
    
    Returns:
    List of objects.
  - GetIncorrect
```
public final StiComponentsCollection GetIncorrect(boolean onlySelect)
```
    Returns the list of all objects which require motion between containers.
    
    Returns:
    List of objects.
  - Correct
```
public final void Correct()
```
    Corrects in the container all objects which require motion between containers.
  - Correct
```
public final void Correct(boolean onlySelect)
```
    Corrects in container all objects which require moving.
    
    Parameters:
    onlySelect - If true then correct only selected components.
  - checkLargeHeight
```
public void checkLargeHeight(boolean needFullCalculation)
```
  - GetDockableComponent
```
public final StiComponent GetDockableComponent()
```
    Returns the first docked and selected component.
  - GetFirstSelectableCompanent
```
public final StiComponent GetFirstSelectableCompanent()
```
    Returns the first selected component.
    
    Returns:
  - ResetSelection
```
public final void ResetSelection()
```
    Resets selection from all selected objects in the container.
  - GetSelectedComponents
```
public final StiComponentsCollection GetSelectedComponents()
```
    Returns the array of the selected components.
    
    Returns:
    The array of selected components.
  - GetSelectedComponentsWithChilds
```
public final StiComponentsCollection GetSelectedComponentsWithChilds()
```
    Returns the array of the selected objects including child of the selected objects.
    
    Returns:
    The array of selected components.
  - SelectInRectangleCheckBands
```
public final void SelectInRectangleCheckBands(StiRectangle rect)
```
  - SelectInRectangle
```
public final void SelectInRectangle(StiRectangle rect)
```
    Selects all objects in the container which intersect with the specified rectangle.
    
    Parameters:
    rect - Specified rectangle.
  - SelectAll
```
public final void SelectAll()
```
    Select all components in container.
  - SelectComponent
```
public final void SelectComponent(StiComponent component)
```
    Selects the specified component in the container.
    
    Parameters:
    component - Object for selection.
  - ContainerToPage
```
public final StiPoint ContainerToPage(StiPoint point)
```
    Converts a point of coordinates of the container into coodinates of a page.
    
    Parameters:
    point - Point to be converted.
    
    Returns:
    Converted point.
  - PageToContainer
```
public final StiPoint PageToContainer(StiPoint point)
```
    Converts a point of coordinates of a page into coodinates of a container.
    
    Parameters:
    point - Point to be converted.
    
    Returns:
    Converted point.
  - ContainerToPage
```
public final StiRectangle ContainerToPage(StiRectangle rect)
```
    Converts a rectangle from container coordinates into coordinates of a page.
    
    Parameters:
    rect - Rectangle to be converted.
    
    Returns:
    Converted rectangle.
  - PageToContainer
```
public final StiRectangle PageToContainer(StiRectangle rectIn)
```
    Converts a rectangle from coordinates of a page into container coordinates.
    
    Parameters:
    rect - Rectangle to be converted.
    
    Returns:
    Converted rectangle.
  - GetComponents
```
public final StiComponentsCollection GetComponents()
```
    Returns the list of all components which are located in the container.
    
    Returns:
    List of components.
  - GetComponentsList
```
public final java.util.ArrayList<StiComponent> GetComponentsList()
```
    Returns the list of all components which are located in the container.
    
    Returns:
    List of components.
  - GetComponentsCount
```
public int GetComponentsCount()
```
  - RemoveAllSelected
```
public final void RemoveAllSelected()
```
    Removes all selected object from the container.
  - MoveComponentsToPage
```
public final void MoveComponentsToPage()
```
    Converts coordinates of all objects into coordinates of a page and moves objects on the page.
  - ConvertSelectedToPage
```
public final void ConvertSelectedToPage()
```
    Converts coordinates of all objects into coordinates of a page.
  - ConvertToPage
```
public final void ConvertToPage()
```
    Converts objects from all coordinates into coordinates of a page without move them on a page.
  - InvertComponentsPosition
```
public final void InvertComponentsPosition()
```
  - Convert
```
public final void Convert(StiUnit oldUnit,
           StiUnit newUnit,
           boolean convertComponents)
```
    Converts a component out of one unit into another.
    
    Parameters:
    oldUnit - Old units.
    newUnit - New units.
  - convert
```
public void convert(StiUnit oldUnit,
           StiUnit newUnit)
```
    Converts a component out of one unit into another.
    
    Specified by:
    
    convert in interface IStiUnitConvert
    
    Overrides:
    
    convert in class StiComponent
    
    Parameters:
    oldUnit - Old units.
    newUnit - New units.
  - setComponentsWithSetParent
```
public void setComponentsWithSetParent(StiComponentsCollection components)
```
  - getComponentPlacementForChildren
```
public java.lang.String getComponentPlacementForChildren()
```
  - setParentComponentIsBand
```
public void setParentComponentIsBand(boolean value)
```
  - setParentComponentIsCrossBand
```
public void setParentComponentIsCrossBand(boolean value)
```
  - setContainerInfoV2
```
public void setContainerInfoV2(StiContainerInfoV2 containerInfoV2)
```
  - getClientRectangle
```
public StiRectangle getClientRectangle()
```
    Description copied from class: StiComponent
    
    gets or sets the client area of a component.
    
    Overrides:
    
    getClientRectangle in class StiComponent
  - getName
```
public java.lang.String getName()
```
    Description copied from class: StiBase
    
    Gets or sets a component name.
    
    Specified by:
    
    getName in interface IStiName
    
    Overrides:
    
    getName in class StiBase
  - getComponentStyle
```
public java.lang.String getComponentStyle()
```
    Description copied from class: StiComponent
    
    gets or sets a style of a component.
    
    Overrides:
    
    getComponentStyle in class StiComponent
  - getGuid
```
public java.lang.String getGuid()
```
    Description copied from class: StiComponent
    
    gets or sets a guid of component.
    
    Specified by:
    
    getGuid in interface IStiComponentGuid
    
    Overrides:
    
    getGuid in class StiComponent
  - getTagValue
```
public java.lang.String getTagValue()
```
    Description copied from class: StiComponent
    
    gets or sets tag of a component.
    
    Overrides:
    
    getTagValue in class StiComponent

Class StiContainer

Field Summary

Fields inherited from class com.stimulsoft.report.components.StiComponent

Fields inherited from class com.stimulsoft.base.services.StiService

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

Constructor Summary

Method Summary

Methods inherited from class com.stimulsoft.report.components.StiComponent

Methods inherited from class com.stimulsoft.report.StiBase

Methods inherited from class com.stimulsoft.base.services.StiService

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

Methods inherited from class java.lang.Object

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

Field Detail

border

brush

ParentComponentIsBand

ParentComponentIsCrossBand

collapsingIndex

components

PropertyBlocked

Constructor Detail

StiContainer

StiContainer

Method Detail

SaveToJsonObject

LoadFromJsonObject

isForceSerializeToReport

setForceSerializeToReport

getCanBreak

getCollapsingTreePath

setCollapsingTreePath

setCanBreak

Break

clone

clone

getBorder

setBorder

getBrush

setBrush

saveState

RestoreState

ClearAllStates

getActualSize

getActualSize

getContainerInfoV1

getContainerInfoV2

getPriority

getToolboxPosition

getComponentType

getLocalizedCategory

getLocalizedName

getCollapsedValue

setCollapsedValue

getCollapsingIndex

setCollapsingIndex

getHasSelected

getDefaultClientRectangle

getComponents

setComponents

checkBlockedException

CheckBlockedException

getBlocked

setBlocked

OnComponentAdded

OnComponentRemoved

SetParentStylesToChilds

SetParentStylesToChilds

OffsetLocation

ChangePosition

Normalize

SetLink

SetBorder

GetBorder

SetVertAlign

GetVertAlignment

SetHorAlign

GetHorAlignment

SetTextHorAlign

GetTextHorAlignment