Packagestimulsoft.report.components.complexComponents
Classpublic class StiContainer
InheritanceStiContainer Inheritance StiComponent Inheritance StiBase Inheritance StiService Inheritance StiObject Inheritance Object
Implements IStiBreakable, IStiIgnoryStyle, IStiBorder, IStiBrush, IStiSerializableToDocument
Subclasses StiBand, StiClone, StiColumnsContainer, StiCrossTab, StiFooterMarkerContainer, StiGroup, StiLevelContainer, StiNewPageContainer, StiPanel, StiReportControl, StiSubReport



Public Properties
 PropertyDefined By
 InheritedafterPrintEvent : StiAfterPrintEvent
Occurs after the component printing.
StiComponent
 Inheritedalias : String
Gets or sets a text that will be shown instead of a component name.
StiComponent
 InheritedallowDelete : Boolean
[read-only] Gets a value which indicates whether deleting of the components is allowed.
StiComponent
 InheritedbeforePrintEvent : StiBeforePrintEvent
Occurs before printing of the component.
StiComponent
  blocked : Boolean
Internal use only.
StiContainer
 Inheritedbookmark : StiBookmarkExpression
Gets or sets the expression to fill a component bookmark.
StiComponent
 InheritedbookmarkValue : String
Gets or sets the component bookmark.
StiComponent
  border : StiBorder
Gets or sets frame of the component.
StiContainer
 Inheritedbottom : Number
[read-only] Gets bottom position of a component.
StiComponent
  brush : StiBrush
Gets or sets a brush to fill a component.
StiContainer
  canBreak : Boolean
Gets or sets value which indicates whether the component can or cannot break its contents on several pages.
StiContainer
 InheritedcanGrow : Boolean
Gets or sets a value which indicates that this object can grow.
StiComponent
 InheritedcanShrink : Boolean
Gets or sets value which indicates that this object can shrink.
StiComponent
 InheritedclickEvent : StiClickEvent
Occurs when user clicks on the component in the window of viewer.
StiComponent
 InheritedclientRectangle : StiRectangle
Gets or sets the client area of a component.
StiComponent
  collapsedValue : Object
Gets or sets collapsed value of the component.
StiContainer
  collapsingIndex : int
StiContainer
 InheritedcomponentPlacement : String
StiComponent
  components : StiComponentsCollection
Gets or sets a collection of components.
StiContainer
 InheritedcomponentStyle : String
Gets or sets a style of a component.
StiComponent
  componentType : int
[override] [read-only] Gets the type of processing when printing.
StiContainer
 Inheritedconditions : StiConditionsCollection
Gets or sets the collection of conditions.
StiComponent
  containerInfoV2 : StiContainerInfoV2
[read-only]
StiContainer
 InheritedcurrentBookmark : StiBookmark
Gets or sets current bookmark for this component.
StiComponent
  defaultClientRectangle : StiRectangle
[override] [read-only] Gets or sets the default client area of a component.
StiContainer
 InheriteddelimiterComponent : Boolean
Gets or sets a value indicates that this component is used as the delimiter.
StiComponent
 InheriteddisplayRectangle : StiRectangle
Gets or sets a rectangle of the component which it fills.
StiComponent
 Inheriteddockable : Boolean
Gets or sets a value which indicates whether the component will be docked or not.
StiComponent
 InheriteddockStyle : int
Gets or sets a type of the component docking.
StiComponent
 InheriteddoubleClickEvent : StiDoubleClickEvent
Occurs when user double clicks on the component in the window of viewer.
StiComponent
 InheriteddrillDownParameters : StiDictionaryCollection
StiComponent
 Inheritedenabled : Boolean
Gets or sets a value which indicates will this component be available or not.
StiComponent
 InheritedforceRedrawAll : Boolean
[read-only] Gets a value which indicates whether it is necessary to draw again the whole page when moving the component or changing its sizes in the designer.
StiComponent
 InheritedgetBookmarkEvent : StiGetBookmarkEvent
Occurs when getting a Bookmark for the component.
StiComponent
 InheritedgetDrillDownReportEvent : StiGetDrillDownReportEvent
Occurs when it is required to get a report for the Drill-Down operation.
StiComponent
 InheritedgetHyperlinkEvent : StiGetHyperlinkEvent
Occurs when getting a Hyperlink for the component.
StiComponent
 InheritedgetTagEvent : StiGetTagEvent
Occurs when getting a Tag for the component.
StiComponent
 InheritedgetToolTipEvent : StiGetToolTipEvent
Occurs when getting a ToolTip for the component.
StiComponent
 InheritedgrowToHeight : Boolean
Gets or sets a value which indicates that the height of this component increases/decreases to the bottom of a container.
StiComponent
 Inheritedguid : String
StiComponent
  hasSelected : Boolean
[read-only] Internal use only.
StiContainer
 Inheritedheight : Number
Gets or sets height of a component.
StiComponent
 InheritedhighlightState : int
Gets or sets a state of highlight.
StiComponent
 Inheritedhyperlink : StiHyperlinkExpression
Gets or sets an expression to fill a component hyperlink.
StiComponent
 InheritedhyperlinkValue : String
Gets or sets hyperlink of a component.
StiComponent
 InheritedignoreNamingRule : Boolean
Internal use only.
StiComponent
 Inheritedinherited : Boolean
StiComponent
 Inheritedinteraction : StiInteraction
Gets interaction options of this component.
StiComponent
 InheritedisAllowUseInTableMode : Boolean
[read-only] Возможно ли добавиль компонент в групповое выделение
StiComponent
 InheritedisAutomaticDock : Boolean
[read-only] Gets a value which indicates that this is an automatic docking.
StiComponent
 InheritedisCross : Boolean
[read-only]
StiComponent
 InheritedisDesigning : Boolean
[read-only] Gets a value which indicates that the report in which a component is placed is being designed.
StiComponent
 InheritedisEnabled : Boolean
[read-only]
StiComponent
 InheritedisExporting : Boolean
[read-only] Gets or sets value, which indicates that the report is exporting.
StiComponent
 InheritedisPrinting : Boolean
[read-only] Gets a value which indicates that the component has already been printed.
StiComponent
 InheritedisRendered : Boolean
Gets or sets a value which indicates whether a component is rendered or not.
StiComponent
 InheritedisSelected : Boolean
Gets or sets value indicates is the component selected or not.
StiComponent
 InheritedisThumbnails : Boolean
[read-only]
StiComponent
 Inheritedleft : Number
Gets or sets left position of a component.
StiComponent
 Inheritedlinked : Boolean
Gets or sets a value which indicates whether the object snap to the container is turned on.
StiComponent
 InheritedlocalizedCategory : String
[read-only] Gets a localized name of the component category.
StiBase
  localizedName : String
[override] [read-only] Gets a localized component name.
StiContainer
 Inheritedlocked : Boolean
Gets or sets a value which indicates that moving is locked.
StiComponent
 InheritedmaxSize : StiSize
Gets or sets maximal size.
StiComponent
 InheritedminSize : StiSize
Gets or sets minimal size.
StiComponent
 InheritedmouseEnterEvent : StiMouseEnterEvent
Occurs when user enters the mouse into the area of the component in the window of viewer.
StiComponent
 InheritedmouseLeaveEvent : StiMouseLeaveEvent
Occurs when user leaves the mouse into the area of the component in the window of viewer.
StiComponent
 Inheritedname : String
[override] Gets or sets a name of a component.
StiComponent
 Inheritedpage : StiPage
Gets or sets the page on which an object is located.
StiComponent
 Inheritedparent : StiContainer
Gets or sets the container in which an object is located.
StiComponent
 InheritedparentBookmark : StiBookmark
Gets or sets parent bookmark for this component.
StiComponent
  parentComponentIsBand : Boolean = false
Если true, то Parent компонент этого контейнера является Band.
StiContainer
 Inheritedprintable : Boolean
Gets or sets a value which indicates whether a component is printable or not.
StiComponent
 InheritedprintOn : int
Gets or sets a value which indicates on what pages component will be printed.
StiComponent
  priority : int
[override] [read-only] Gets a component priority.
StiContainer
 Inheritedproperties : StiRepositoryItems
StiService
 Inheritedref : int
StiBase
 InheritedrenderedCount : int
Gets or sets a value which indicates how many times a component is rendered.
StiComponent
 Inheritedreport : StiReport
Gets or sets the report in which the component is located.
StiComponent
 Inheritedrestrictions : int
Gets or sets value which indicates the restrictions of a component.
StiComponent
 Inheritedright : Number
[read-only] Gets right position of a component.
StiComponent
 InheritedselectionTick : int
StiComponent
 InheritedselectRectangle : StiRectangle
Gets or sets a rectangle of a component selection.
StiComponent
 InheritedserviceCategory : String
[read-only] Gets a service category.
StiService
 InheritedserviceInfo : String
[read-only] Gets a service description.
StiService
 InheritedserviceName : String
[override] [read-only] Gets a service name.
StiBase
 InheritedserviceType : Class
[read-only] Gets a service type.
StiService
 Inheritedshift : Boolean
Gets or sets a value which indicates that this component can be shifted.
StiComponent
 InheritedshiftMode : int
Gets or sets a value which indicates the shift mode of a component.
StiComponent
 InheritedshowQuickButtons : Boolean
Gets or sets a value which indicates whether it is necessary to show quick buttons.
StiComponent
 Inheritedstates : StiStatesManager
[read-only] Gets the component states manager.
StiComponent
 Inheritedtag : StiTagExpression
Gets or sets the expression to fill a component tag.
StiComponent
 InheritedtagValue : String
Gets or sets tag of a component.
StiComponent
 InheritedtoolTip : StiToolTipExpression
Gets or sets the expression to fill a component tooltip.
StiComponent
 InheritedtoolTipValue : String
Gets or sets a component tips.
StiComponent
 Inheritedtop : Number
Gets or sets top position of a component.
StiComponent
 InheriteduseParentStyles : Boolean
Gets or sets a value which indicates that this component must use styles from parent component.
StiComponent
 Inheritedwidth : Number
Gets or sets width of a component.
StiComponent
Public Methods
 MethodDefined By
  
StiContainer
  
alignTo(aligning:String):void
Aligns, in the rectangle of selected objects, all selected objects.
StiContainer
  
alignToGrid(comp:StiComponent = null):void
Aligns to grid all selected components in the container.
StiContainer
 Inherited
applyConditions(sender:Object, conditions:StiArrayList):void
StiComponent
  
breakk(dividedComponent:StiComponent, devideFactor:Number):Boolean
Divides content of components in two parts.
StiContainer
  
Brings to front objects of the list in the container.
StiContainer
 Inherited
canContainIn(component:StiComponent):Boolean
Specifies that this component may be located in the specified component.
StiComponent
  
Changes the position of the selected component.
StiContainer
 Inherited
StiComponent
  
[override] Clear all earlier saved object states.
StiContainer
  
clone(... args):Object
[override]
StiContainer
 Inherited
componentToPage(value:Number):Number
Converts a rectangle from the parent-container coordinates into coordinates of a page.
StiComponent
 Inherited
Converts a rectangle from the parent-container coordinates into coordinates of a page.
StiComponent
 Inherited
Converts a rectangle from the parent-container coordinates into coordinates of a page.
StiComponent
  
Converts a rectangle from container coordinates into coordinates of a page.
StiContainer
  
Converts a point of coordinates of the container into coodinates of a page.
StiContainer
  
convert(oldUnit:StiUnit, newUnit:StiUnit, convertComponents:Boolean = true):void
[override] Converts a component out of one unit into another.
StiContainer
  
correct(onlySelect:Boolean = false):void
Corrects in the container all objects which require motion between containers.
StiContainer
  
deserializeDocument(value:XMLNode):void
StiContainer
 Inherited
doBookmark():void
Invokes the GetBookmark event.
StiComponent
 Inherited
Docks the component and all of its subordinate components.
StiComponent
 Inherited
StiComponent
 Inherited
Raises the GetBookmark event.
StiComponent
 Inherited
[static]
StiComponent
  
equals(object:Object):Boolean
[override]
StiContainer
  
[override]
StiContainer
  
getBorder():Object
Returns a frame of the object of the type IStiBorder being met first.
StiContainer
  
getComponentInControl(x:Number, y:Number, usePage:Boolean):StiComponent
Returns an object in which zone of controlling coordinates are got.
StiContainer
  
getComponentInPoint(x:Number, y:Number):StiComponent
Returns an object in which zone of controlling coordinates are got.
StiContainer
  
Returns the list of all components which are located in the container.
StiContainer
  
Returns an container in which client zone coordinates are got.
StiContainer
 Inherited
Returns the DataBand in which the component is located.
StiComponent
 Inherited
Returns a rectangle of the component showing.
StiComponent
  
Returns the first docked and selected component.
StiContainer
 Inherited
getDockRegion(parent:StiComponent, useColumns:Boolean = true):StiRectangle
Retuns an empty rectangle to which docking is possible.
StiComponent
  
Returns the first selected component.
StiContainer
 Inherited
Returns the GroupHeaderBand in which the component is located.
StiComponent
  
getIncorrect(onlySelect:Boolean = false):StiComponentsCollection
Returns the list of all objects which require motion between containers.
StiContainer
  
getLink():Object
Returns linked of the object being met first.
StiContainer
  
getLock():Object
Returns lock of the object being met first.
StiContainer
 Inherited
getPaintRectangle(convertToHInches:Boolean = true, convertZoom:Boolean = true, docking:Boolean = true):StiRectangle
Makes all necessary coversions for showing an object and returns its coordinates.
StiComponent
 Inherited
getQuickInfo():String
StiComponent
 Inherited
getReport():Object
StiComponent
  
Returns the array of the selected components.
StiContainer
  
Returns the array of the selected objects including child of the selected objects.
StiContainer
  
Returns the rectangle that includes all selected objects in the container.
StiContainer
 Inherited
Get a short object type name (without library path).
StiObject
 Inherited
getType():Class
StiObject
 Inherited
getTypeName():String
StiObject
 Inherited
StiComponent
 Inherited
invert():void
Invert selection of component.
StiComponent
 Inherited
invokeAfterPrint(sender:Object):void
Raises the AfterPrint event.
StiComponent
 Inherited
invokeBeforePrint(sender:Object):void
Raises the BeforePrint event.
StiComponent
 Inherited
StiComponent
 Inherited
isExportAsImage(format:int):Boolean
StiComponent
 Inherited
isParentSelect(component:StiComponent):Boolean
[static] Retuns true if one of the parent component is selected.
StiComponent
 Inherited
isSimple(object:*):Boolean
[static]
StiObject
  
Puts components which are equivalent to their width.
StiContainer
  
makeSameHeight(height:Number):void
Sets the height to all selected objects.
StiContainer
  
Sets the size to all selected objects.
StiContainer
  
makeSameWidth(width:Number):void
Sets the width to all selected objects.
StiContainer
  
Puts components which are equal in their height.
StiContainer
  
[override]
StiContainer
  
Moves backward objects of the list in the container.
StiContainer
  
Converts coordinates of all objects into coordinates of a page and moves objects on the page.
StiContainer
  
Moves forward objects of the list in the container.
StiContainer
 Inherited
newGuid():void
StiComponent
  
normalize():void
Normalizes all selected objects in the container.
StiContainer
  
offsetLocation(offsetX:Number, offsetY:Number):void
StiContainer
 Inherited
[override] Packs a service.
StiComponent
 Inherited
Converts a rectangle from coordinates of a page into the parent-container coordinates.
StiComponent
 Inherited
Converts a rectangle from coordinates of a page into the parent-container coordinates.
StiComponent
  
Converts a rectangle from coordinates of a page into container coordinates.
StiContainer
  
Converts a point from coordinates of a page into container coordinates.
StiContainer
 Inherited
paint(args:StiPaintArgs):void
StiComponent
 Inherited
StiComponent
 Inherited
prepare():void
Подготавливает компонент для рендеринга.
StiComponent
 Inherited
StiComponent
 Inherited
StiComponent
 Inherited
reset():void
Reset selection of component.
StiComponent
  
Resets selection from all selected objects in the container.
StiContainer
  
restoreState(stateName:String):void
[override] Restores the earlier saved object state.
StiContainer
  
saveState(stateName:String):void
[override] Saves the current state of an object.
StiContainer
 Inherited
select():void
Select component.
StiComponent
  
selectAll():void
Select all components in container.
StiContainer
  
Selects the specified component in the container.
StiContainer
  
Selects all objects in the container which intersect with the specified rectangle.
StiContainer
  
StiContainer
  
sendToBack():void
Sends to back objects of the list in the container.
StiContainer
  
StiContainer
  
setBorder(border:StiBorder):void
Sets StiBorder from all selected objects in the container.
StiContainer
  
Centers horizontally all selected objects.
StiContainer
  
Centers vertically all selected objects.
StiContainer
  
setLink(linked:Boolean):void
Sets Link from all selected objects in the container.
StiContainer
  
setLock(locked:Boolean):void
Sets Lock from all selected objects in the container.
StiContainer
 Inherited
Internal use only.
StiComponent
  
StiContainer
 Inherited
StiComponent
  
StiContainer
 Inherited
toString():String
Returns an Alias of the report or the Name of the report.
StiComponent
 Inherited
unPrepare():void
Очищает компонент после рендеринга.
StiComponent
Protected Methods
 MethodDefined By
 Inherited
allowPrintOn():Boolean
StiComponent
  
checkBlockedException(propertyName:String):void
StiContainer
 Inherited
StiComponent
Protected Constants
 ConstantDefined By
  PropertyBlocked : Object
[static]
StiContainer
 InheritedPropertyComponentStyle : Object
[static]
StiComponent
 InheritedPropertyDelimiterComponent : Object
[static]
StiComponent
 InheritedPropertyDockable : Object
[static]
StiComponent
 InheritedPropertyInherited : Object
[static]
StiComponent
 InheritedPropertyLinked : Object
[static]
StiComponent
 InheritedPropertyLocked : Object
[static]
StiComponent
 InheritedPropertyRenderedCount : Object
[static]
StiComponent
 InheritedPropertyRestrictions : Object
[static]
StiComponent
 InheritedPropertySelectionTick : Object
[static]
StiComponent
 InheritedPropertyShowQuickButtons : Object
[static]
StiComponent
 InheritedPropertyUseParentStyles : Object
[static]
StiComponent
Property Detail
blockedproperty
blocked:Boolean

Internal use only. Это свойство используется для блокирования измнения свойств бэнда, изменение которых во время построения бэнда может исказить результат.


Implementation
    public function get blocked():Boolean
    public function set blocked(value:Boolean):void
borderproperty 
border:StiBorder

Gets or sets frame of the component.


Implementation
    public function get border():StiBorder
    public function set border(value:StiBorder):void
brushproperty 
brush:StiBrush

Gets or sets a brush to fill a component.


Implementation
    public function get brush():StiBrush
    public function set brush(value:StiBrush):void
canBreakproperty 
canBreak:Boolean

Gets or sets value which indicates whether the component can or cannot break its contents on several pages.


Implementation
    public function get canBreak():Boolean
    public function set canBreak(value:Boolean):void
collapsedValueproperty 
collapsedValue:Object

Gets or sets collapsed value of the component.


Implementation
    public function get collapsedValue():Object
    public function set collapsedValue(value:Object):void
collapsingIndexproperty 
collapsingIndex:int


Implementation
    public function get collapsingIndex():int
    public function set collapsingIndex(value:int):void
componentsproperty 
components:StiComponentsCollection

Gets or sets a collection of components.


Implementation
    public function get components():StiComponentsCollection
    public function set components(value:StiComponentsCollection):void
componentTypeproperty 
componentType:int  [read-only] [override]

Gets the type of processing when printing.


Implementation
    public function get componentType():int
containerInfoV2property 
containerInfoV2:StiContainerInfoV2  [read-only]


Implementation
    public function get containerInfoV2():StiContainerInfoV2
defaultClientRectangleproperty 
defaultClientRectangle:StiRectangle  [read-only] [override]

Gets or sets the default client area of a component.


Implementation
    public function get defaultClientRectangle():StiRectangle
hasSelectedproperty 
hasSelected:Boolean  [read-only]

Internal use only.


Implementation
    public function get hasSelected():Boolean
localizedNameproperty 
localizedName:String  [read-only] [override]

Gets a localized component name.


Implementation
    public function get localizedName():String
parentComponentIsBandproperty 
public var parentComponentIsBand:Boolean = false

Если true, то Parent компонент этого контейнера является Band.

priorityproperty 
priority:int  [read-only] [override]

Gets a component priority.


Implementation
    public function get priority():int
Constructor Detail
StiContainer()Constructor
public function StiContainer(rect:StiRectangle = null)



Parameters
rect:StiRectangle (default = null)
Method Detail
alignTo()method
public function alignTo(aligning:String):void

Aligns, in the rectangle of selected objects, all selected objects.

Parameters

aligning:String

alignToGrid()method 
public function alignToGrid(comp:StiComponent = null):void

Aligns to grid all selected components in the container.

Parameters

comp:StiComponent (default = null)

breakk()method 
public function breakk(dividedComponent:StiComponent, devideFactor:Number):Boolean

Divides content of components in two parts. Returns result of dividing. If true, then component is successful divided.

Parameters

dividedComponent:StiComponent
 
devideFactor:Number

Returns
Boolean
bringToFront()method 
public function bringToFront():void

Brings to front objects of the list in the container.

changePosition()method 
public function changePosition(delta:StiRectangle):void

Changes the position of the selected component.

Parameters

delta:StiRectangle

checkBlockedException()method 
protected function checkBlockedException(propertyName:String):void

Parameters

propertyName:String

clearAllStates()method 
override public function clearAllStates():void

Clear all earlier saved object states.

clone()method 
override public function clone(... args):Object

Parameters

... args

Returns
Object
containerToPage()method 
public function containerToPage(rect:StiRectangle):StiRectangle

Converts a rectangle from container coordinates into coordinates of a page.

Parameters

rect:StiRectangle

Returns
StiRectangle
containerToPageP()method 
public function containerToPageP(point:StiPoint):StiPoint

Converts a point of coordinates of the container into coodinates of a page.

Parameters

point:StiPoint

Returns
StiPoint
convert()method 
override public function convert(oldUnit:StiUnit, newUnit:StiUnit, convertComponents:Boolean = true):void

Converts a component out of one unit into another.

Parameters

oldUnit:StiUnit
 
newUnit:StiUnit
 
convertComponents:Boolean (default = true)

correct()method 
public function correct(onlySelect:Boolean = false):void

Corrects in the container all objects which require motion between containers.

Parameters

onlySelect:Boolean (default = false)

deserializeDocument()method 
public function deserializeDocument(value:XMLNode):void

Parameters

value:XMLNode

equals()method 
override public function equals(object:Object):Boolean

Parameters

object:Object

Returns
Boolean
getActualSize()method 
override public function getActualSize():StiSize

Returns
StiSize
getBorder()method 
public function getBorder():Object

Returns a frame of the object of the type IStiBorder being met first. Scans all selected objects in the container.

Returns
Object
getComponentInControl()method 
public function getComponentInControl(x:Number, y:Number, usePage:Boolean):StiComponent

Returns an object in which zone of controlling coordinates are got.

Parameters

x:Number
 
y:Number
 
usePage:Boolean

Returns
StiComponent
getComponentInPoint()method 
public function getComponentInPoint(x:Number, y:Number):StiComponent

Returns an object in which zone of controlling coordinates are got.

Parameters

x:Number
 
y:Number

Returns
StiComponent
getComponents()method 
public function getComponents():StiComponentsCollection

Returns the list of all components which are located in the container.

Returns
StiComponentsCollection
getContainerInRect()method 
public function getContainerInRect(rect:StiRectangle, component:StiComponent):StiContainer

Returns an container in which client zone coordinates are got.

Parameters

rect:StiRectangle
 
component:StiComponent

Returns
StiContainer
getDockableComponent()method 
public function getDockableComponent():StiComponent

Returns the first docked and selected component.

Returns
StiComponent
getFirstSelectableComponent()method 
public function getFirstSelectableComponent():StiComponent

Returns the first selected component.

Returns
StiComponent
getIncorrect()method 
public function getIncorrect(onlySelect:Boolean = false):StiComponentsCollection

Returns the list of all objects which require motion between containers.

Parameters

onlySelect:Boolean (default = false)

Returns
StiComponentsCollection
getLink()method 
public function getLink():Object

Returns linked of the object being met first. Scans all selected objects in the container.

Returns
Object
getLock()method 
public function getLock():Object

Returns lock of the object being met first. Scans all selected objects in the container.

Returns
Object — Lock
getSelectedComponents()method 
public function getSelectedComponents():StiComponentsCollection

Returns the array of the selected components.

Returns
StiComponentsCollection
getSelectedComponentsWithChilds()method 
public function getSelectedComponentsWithChilds():StiComponentsCollection

Returns the array of the selected objects including child of the selected objects.

Returns
StiComponentsCollection
getSelectedRectangle()method 
public function getSelectedRectangle():StiRectangle

Returns the rectangle that includes all selected objects in the container. The rectangle is represented in page coordinates.

Returns
StiRectangle
makeHorizontalSpacingEqual()method 
public function makeHorizontalSpacingEqual():void

Puts components which are equivalent to their width.

makeSameHeight()method 
public function makeSameHeight(height:Number):void

Sets the height to all selected objects.

Parameters

height:Number

makeSameSize()method 
public function makeSameSize(size:StiSize):void

Sets the size to all selected objects.

Parameters

size:StiSize

makeSameWidth()method 
public function makeSameWidth(width:Number):void

Sets the width to all selected objects.

Parameters

width:Number

makeVerticalSpacingEqual()method 
public function makeVerticalSpacingEqual():void

Puts components which are equal in their height.

memberwiseClone()method 
override public function memberwiseClone():Object

Returns
Object
moveBackward()method 
public function moveBackward():void

Moves backward objects of the list in the container.

moveComponentsToPage()method 
public function moveComponentsToPage():void

Converts coordinates of all objects into coordinates of a page and moves objects on the page.

moveForward()method 
public function moveForward():void

Moves forward objects of the list in the container.

normalize()method 
public function normalize():void

Normalizes all selected objects in the container.

offsetLocation()method 
public function offsetLocation(offsetX:Number, offsetY:Number):void

Parameters

offsetX:Number
 
offsetY:Number

pageToContainer()method 
public function pageToContainer(rect:StiRectangle):StiRectangle

Converts a rectangle from coordinates of a page into container coordinates.

Parameters

rect:StiRectangle

Returns
StiRectangle
pageToContainerP()method 
public function pageToContainerP(point:StiPoint):StiPoint

Converts a point from coordinates of a page into container coordinates.

Parameters

point:StiPoint

Returns
StiPoint
resetSelection()method 
public function resetSelection():void

Resets selection from all selected objects in the container.

restoreState()method 
override public function restoreState(stateName:String):void

Restores the earlier saved object state.

Parameters

stateName:String

saveState()method 
override public function saveState(stateName:String):void

Saves the current state of an object.

Parameters

stateName:String

selectAll()method 
public function selectAll():void

Select all components in container.

selectComponent()method 
public function selectComponent(component:StiComponent):void

Selects the specified component in the container.

Parameters

component:StiComponent

selectInRectangle()method 
public function selectInRectangle(rect:StiRectangle):void

Selects all objects in the container which intersect with the specified rectangle.

Parameters

rect:StiRectangle

selectInRectangleCheckBands()method 
public function selectInRectangleCheckBands(rect:StiRectangle):void

Parameters

rect:StiRectangle

sendToBack()method 
public function sendToBack():void

Sends to back objects of the list in the container.

serializeDocument()method 
public function serializeDocument():XMLNode

Returns
XMLNode
setBorder()method 
public function setBorder(border:StiBorder):void

Sets StiBorder from all selected objects in the container. Sets Side, DropShadow, Color, Style. All other elements are ignored.

Parameters

border:StiBorder

setCenterHorizontally()method 
public function setCenterHorizontally():void

Centers horizontally all selected objects.

setCenterVertically()method 
public function setCenterVertically():void

Centers vertically all selected objects.

setLink()method 
public function setLink(linked:Boolean):void

Sets Link from all selected objects in the container.

Parameters

linked:Boolean

setLock()method 
public function setLock(locked:Boolean):void

Sets Lock from all selected objects in the container.

Parameters

locked:Boolean

setParentStylesToChilds()method 
public function setParentStylesToChilds(style:StiBaseStyle = null):void

Parameters

style:StiBaseStyle (default = null)

sortByPriority()method 
public function sortByPriority():void

Constant Detail
PropertyBlockedConstant
protected static const PropertyBlocked:Object