Package com.stimulsoft.report.components.complexcomponents

Class StiContainer

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:
IStiAppExpressionCollection, IStiJsonReportObject, IStiForceSerializable, IStiSerializable, IStiSerializableRef, IStiSerializableToAttributes, IStiName, IStiBorder, IStiBreakable, IStiBrush, IStiCanGrow, IStiCanShrink, IStiComponentGuid, IStiConditions, IStiGrowToHeight, IStiInteraction, IStiPrintOn, IStiSelect, IStiShift, IStiUnitConvert, IStiReportProperty, IStiIgnoryStyle, IStiInherited, IStiStateSaveRestore, Cloneable
Direct Known Subclasses:
StiBand, StiClone, StiColumnsContainer, StiCrossTab, StiFooterMarkerContainer, StiGroup, StiLevelContainer, StiNewPageContainer, StiPanel, StiReportControl, StiSubReport
public class StiContainer extends StiComponent implements IStiBorder, IStiBrush, IStiBreakable, IStiIgnoryStyle, IStiSerializableToAttributes, IStiForceSerializable

  • Field Details

    • border

      public StiBorder border

    • brush

      public StiBrush brush

    • ParentComponentIsBand

      public boolean ParentComponentIsBand

    • ParentComponentIsCrossBand

      public boolean ParentComponentIsCrossBand

    • collapsingIndex

      public int collapsingIndex

    • components

      public StiComponentsCollection components

    • PropertyBlocked

      protected static Object PropertyBlocked

    • engine

      public StiEngine engine

  • Constructor Details

    • 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 Details

    • 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 String getCollapsingTreePath()
      Returns:
      the collapsingTreePath

    • setCollapsingTreePath

      public void setCollapsingTreePath(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<Double> divideLine, StiRefObject<Boolean> haveBreaked)
      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 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 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(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(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<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 String getLocalizedCategory()
      Gets a localized name of the component category.
      Overrides:
      getLocalizedCategory in class StiBase

    • getLocalizedName

      public String getLocalizedName()
      Gets a localized component name.
      Overrides:
      getLocalizedName in class StiBase

    • getCollapsedValue

      public final Object getCollapsedValue()
      Gets or sets collapsed value of the component.

    • setCollapsedValue

      public final void setCollapsedValue(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(String propertyName)

    • CheckBlockedException

      protected void CheckBlockedException(String propertyName)

    • getBlocked

      protected boolean getBlocked()

    • setBlocked

      public void setBlocked(boolean value)

    • OnComponentAdded

      protected void OnComponentAdded(EventArgs e)

    • OnComponentRemoved

      protected void OnComponentRemoved(EventArgs 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 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 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 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 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 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 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 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 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 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:
      component - The component for which positions are being looked for.
      x - Coordinate X for checking(coordinates of a page).
      y - Coordinate Y for checking(coordinates of a page).

    • GetContainerInRect2

      public StiContainer GetContainerInRect2(StiRectangle rect, StiComponent component, 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 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 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 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 String getComponentStyle()
      Description copied from class: StiComponent
      gets or sets a style of a component.
      Overrides:
      getComponentStyle in class StiComponent

    • getGuid

      public 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 Object getTagValue()
      Description copied from class: StiComponent
      gets or sets tag of a component.
      Overrides:
      getTagValue in class StiComponent