Package | stimulsoft.report.components.complexComponents |
Class | public class StiContainer |
Inheritance | StiContainer ![]() ![]() ![]() ![]() ![]() |
Implements | IStiBreakable, IStiIgnoryStyle, IStiBorder, IStiBrush, IStiSerializableToDocument |
Subclasses | StiBand, StiClone, StiColumnsContainer, StiCrossTab, StiFooterMarkerContainer, StiGroup, StiLevelContainer, StiNewPageContainer, StiPanel, StiReportControl, StiSubReport |
Property | Defined By | ||
---|---|---|---|
![]() | afterPrintEvent : StiAfterPrintEvent Occurs after the component printing. | StiComponent | |
![]() | alias : String Gets or sets a text that will be shown instead of a component name. | StiComponent | |
![]() | allowDelete : Boolean [read-only] Gets a value which indicates whether deleting of the components is allowed. | StiComponent | |
![]() | beforePrintEvent : StiBeforePrintEvent Occurs before printing of the component. | StiComponent | |
blocked : Boolean
Internal use only. | StiContainer | ||
![]() | bookmark : StiBookmarkExpression Gets or sets the expression to fill a component bookmark. | StiComponent | |
![]() | bookmarkValue : String Gets or sets the component bookmark. | StiComponent | |
border : StiBorder Gets or sets frame of the component. | StiContainer | ||
![]() | bottom : 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 | ||
![]() | canGrow : Boolean Gets or sets a value which indicates that this object can grow. | StiComponent | |
![]() | canShrink : Boolean Gets or sets value which indicates that this object can shrink. | StiComponent | |
![]() | clickEvent : StiClickEvent Occurs when user clicks on the component in the window of viewer. | StiComponent | |
![]() | clientRectangle : 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 | ||
![]() | componentPlacement : String | StiComponent | |
components : StiComponentsCollection Gets or sets a collection of components. | StiContainer | ||
![]() | componentStyle : String Gets or sets a style of a component. | StiComponent | |
componentType : int [override] [read-only] Gets the type of processing when printing. | StiContainer | ||
![]() | conditions : StiConditionsCollection Gets or sets the collection of conditions. | StiComponent | |
containerInfoV2 : StiContainerInfoV2 [read-only] | StiContainer | ||
![]() | currentBookmark : 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 | ||
![]() | delimiterComponent : Boolean Gets or sets a value indicates that this component is used as the delimiter. | StiComponent | |
![]() | displayRectangle : StiRectangle
Gets or sets a rectangle of the component which it fills. | StiComponent | |
![]() | dockable : Boolean Gets or sets a value which indicates whether the component will be docked or not. | StiComponent | |
![]() | dockStyle : int Gets or sets a type of the component docking. | StiComponent | |
![]() | doubleClickEvent : StiDoubleClickEvent Occurs when user double clicks on the component in the window of viewer. | StiComponent | |
![]() | drillDownParameters : StiDictionaryCollection | StiComponent | |
![]() | enabled : Boolean Gets or sets a value which indicates will this component be available or not. | StiComponent | |
![]() | forceRedrawAll : 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 | |
![]() | getBookmarkEvent : StiGetBookmarkEvent Occurs when getting a Bookmark for the component. | StiComponent | |
![]() | getDrillDownReportEvent : StiGetDrillDownReportEvent Occurs when it is required to get a report for the Drill-Down operation. | StiComponent | |
![]() | getHyperlinkEvent : StiGetHyperlinkEvent Occurs when getting a Hyperlink for the component. | StiComponent | |
![]() | getTagEvent : StiGetTagEvent Occurs when getting a Tag for the component. | StiComponent | |
![]() | getToolTipEvent : StiGetToolTipEvent Occurs when getting a ToolTip for the component. | StiComponent | |
![]() | growToHeight : Boolean Gets or sets a value which indicates that the height of this component increases/decreases to the bottom of a container. | StiComponent | |
![]() | guid : String | StiComponent | |
hasSelected : Boolean [read-only] Internal use only. | StiContainer | ||
![]() | height : Number Gets or sets height of a component. | StiComponent | |
![]() | highlightState : int Gets or sets a state of highlight. | StiComponent | |
![]() | hyperlink : StiHyperlinkExpression Gets or sets an expression to fill a component hyperlink. | StiComponent | |
![]() | hyperlinkValue : String Gets or sets hyperlink of a component. | StiComponent | |
![]() | ignoreNamingRule : Boolean Internal use only. | StiComponent | |
![]() | inherited : Boolean | StiComponent | |
![]() | interaction : StiInteraction Gets interaction options of this component. | StiComponent | |
![]() | isAllowUseInTableMode : Boolean [read-only] Возможно ли добавиль компонент в групповое выделение | StiComponent | |
![]() | isAutomaticDock : Boolean [read-only] Gets a value which indicates that this is an automatic docking. | StiComponent | |
![]() | isCross : Boolean [read-only] | StiComponent | |
![]() | isDesigning : Boolean [read-only] Gets a value which indicates that the report in which a component is placed is being designed. | StiComponent | |
![]() | isEnabled : Boolean [read-only] | StiComponent | |
![]() | isExporting : Boolean [read-only] Gets or sets value, which indicates that the report is exporting. | StiComponent | |
![]() | isPrinting : Boolean [read-only] Gets a value which indicates that the component has already been printed. | StiComponent | |
![]() | isRendered : Boolean Gets or sets a value which indicates whether a component is rendered or not. | StiComponent | |
![]() | isSelected : Boolean Gets or sets value indicates is the component selected or not. | StiComponent | |
![]() | isThumbnails : Boolean [read-only] | StiComponent | |
![]() | left : Number Gets or sets left position of a component. | StiComponent | |
![]() | linked : Boolean Gets or sets a value which indicates whether the object snap to the container is turned on. | StiComponent | |
![]() | localizedCategory : String [read-only] Gets a localized name of the component category. | StiBase | |
localizedName : String [override] [read-only] Gets a localized component name. | StiContainer | ||
![]() | locked : Boolean Gets or sets a value which indicates that moving is locked. | StiComponent | |
![]() | maxSize : StiSize Gets or sets maximal size. | StiComponent | |
![]() | minSize : StiSize Gets or sets minimal size. | StiComponent | |
![]() | mouseEnterEvent : StiMouseEnterEvent Occurs when user enters the mouse into the area of the component in the window of viewer. | StiComponent | |
![]() | mouseLeaveEvent : StiMouseLeaveEvent Occurs when user leaves the mouse into the area of the component in the window of viewer. | StiComponent | |
![]() | name : String [override] Gets or sets a name of a component. | StiComponent | |
![]() | page : StiPage Gets or sets the page on which an object is located. | StiComponent | |
![]() | parent : StiContainer Gets or sets the container in which an object is located. | StiComponent | |
![]() | parentBookmark : StiBookmark Gets or sets parent bookmark for this component. | StiComponent | |
parentComponentIsBand : Boolean = false Если true, то Parent компонент этого контейнера является Band. | StiContainer | ||
![]() | printable : Boolean Gets or sets a value which indicates whether a component is printable or not. | StiComponent | |
![]() | printOn : 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 | ||
![]() | properties : StiRepositoryItems | StiService | |
![]() | ref : int | StiBase | |
![]() | renderedCount : int Gets or sets a value which indicates how many times a component is rendered. | StiComponent | |
![]() | report : StiReport Gets or sets the report in which the component is located. | StiComponent | |
![]() | restrictions : int Gets or sets value which indicates the restrictions of a component. | StiComponent | |
![]() | right : Number [read-only] Gets right position of a component. | StiComponent | |
![]() | selectionTick : int | StiComponent | |
![]() | selectRectangle : StiRectangle Gets or sets a rectangle of a component selection. | StiComponent | |
![]() | serviceCategory : String [read-only] Gets a service category. | StiService | |
![]() | serviceInfo : String [read-only] Gets a service description. | StiService | |
![]() | serviceName : String [override] [read-only] Gets a service name. | StiBase | |
![]() | serviceType : Class [read-only] Gets a service type. | StiService | |
![]() | shift : Boolean Gets or sets a value which indicates that this component can be shifted. | StiComponent | |
![]() | shiftMode : int Gets or sets a value which indicates the shift mode of a component. | StiComponent | |
![]() | showQuickButtons : Boolean Gets or sets a value which indicates whether it is necessary to show quick buttons. | StiComponent | |
![]() | states : StiStatesManager [read-only] Gets the component states manager. | StiComponent | |
![]() | tag : StiTagExpression Gets or sets the expression to fill a component tag. | StiComponent | |
![]() | tagValue : String Gets or sets tag of a component. | StiComponent | |
![]() | toolTip : StiToolTipExpression Gets or sets the expression to fill a component tooltip. | StiComponent | |
![]() | toolTipValue : String Gets or sets a component tips. | StiComponent | |
![]() | top : Number Gets or sets top position of a component. | StiComponent | |
![]() | useParentStyles : Boolean Gets or sets a value which indicates that this component must use styles from parent component. | StiComponent | |
![]() | width : Number Gets or sets width of a component. | StiComponent |
Method | Defined By | ||
---|---|---|---|
StiContainer(rect:StiRectangle = null) | 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 | ||
![]() | applyConditions(sender:Object, conditions:StiArrayList):void | StiComponent | |
breakk(dividedComponent:StiComponent, devideFactor:Number):Boolean Divides content of components in two parts. | StiContainer | ||
bringToFront():void Brings to front objects of the list in the container. | StiContainer | ||
![]() | canContainIn(component:StiComponent):Boolean Specifies that this component may be located in the specified component. | StiComponent | |
changePosition(delta:StiRectangle):void Changes the position of the selected component. | StiContainer | ||
![]() | checkForParentComponent(comp:StiComponent):Boolean | StiComponent | |
clearAllStates():void [override] Clear all earlier saved object states. | StiContainer | ||
clone(... args):Object [override] | StiContainer | ||
![]() | componentToPage(value:Number):Number
Converts a rectangle from the parent-container coordinates into coordinates of a page. | StiComponent | |
![]() |
Converts a rectangle from the parent-container coordinates into coordinates of a page. | StiComponent | |
![]() |
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 | ||
[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 | ||
![]() | doBookmark():void Invokes the GetBookmark event. | StiComponent | |
![]() | dockToContainer():void Docks the component and all of its subordinate components. | StiComponent | |
![]() | StiComponent | ||
![]() | doGetBookmark():void Raises the GetBookmark event. | StiComponent | |
![]() | [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 | ||
![]() | Returns the DataBand in which the component is located. | StiComponent | |
![]() | Returns a rectangle of the component showing. | StiComponent | |
Returns the first docked and selected component. | StiContainer | ||
![]() | Retuns an empty rectangle to which docking is possible. | StiComponent | |
Returns the first selected component. | StiContainer | ||
![]() | 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 | ||
![]() | getPaintRectangle(convertToHInches:Boolean = true, convertZoom:Boolean = true, docking:Boolean = true):StiRectangle Makes all necessary coversions for showing an object and returns its coordinates. | StiComponent | |
![]() | getQuickInfo():String | StiComponent | |
![]() | 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 | ||
![]() | getShortTypeName():String Get a short object type name (without library path). | StiObject | |
![]() | getType():Class | StiObject | |
![]() | getTypeName():String | StiObject | |
![]() | StiComponent | ||
![]() | invert():void Invert selection of component. | StiComponent | |
![]() | invokeAfterPrint(sender:Object):void Raises the AfterPrint event. | StiComponent | |
![]() | invokeBeforePrint(sender:Object):void Raises the BeforePrint event. | StiComponent | |
![]() | invokeEvents():void | StiComponent | |
![]() | isExportAsImage(format:int):Boolean | StiComponent | |
![]() | isParentSelect(component:StiComponent):Boolean [static] Retuns true if one of the parent component is selected. | StiComponent | |
![]() | isSimple(object:*):Boolean [static] | StiObject | |
makeHorizontalSpacingEqual():void Puts components which are equivalent to their width. | StiContainer | ||
makeSameHeight(height:Number):void Sets the height to all selected objects. | StiContainer | ||
makeSameSize(size:StiSize):void Sets the size to all selected objects. | StiContainer | ||
makeSameWidth(width:Number):void Sets the width to all selected objects. | StiContainer | ||
makeVerticalSpacingEqual():void Puts components which are equal in their height. | StiContainer | ||
memberwiseClone():Object [override] | StiContainer | ||
moveBackward():void Moves backward objects of the list in the container. | StiContainer | ||
moveComponentsToPage():void Converts coordinates of all objects into coordinates of a page and moves objects on the page. | StiContainer | ||
moveForward():void Moves forward objects of the list in the container. | StiContainer | ||
![]() | newGuid():void | StiComponent | |
normalize():void Normalizes all selected objects in the container. | StiContainer | ||
offsetLocation(offsetX:Number, offsetY:Number):void | StiContainer | ||
![]() | packService():void [override] Packs a service. | StiComponent | |
![]() |
Converts a rectangle from coordinates of a page into the parent-container coordinates. | StiComponent | |
![]() |
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 | ||
![]() | paint(args:StiPaintArgs):void | StiComponent | |
![]() | paintSelection(args:StiPaintArgs):void | StiComponent | |
![]() | prepare():void Подготавливает компонент для рендеринга. | StiComponent | |
![]() | processRemoveComponent():void | StiComponent | |
![]() | StiComponent | ||
![]() | reset():void Reset selection of component. | StiComponent | |
resetSelection():void 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 | ||
![]() | select():void Select component. | StiComponent | |
selectAll():void Select all components in container. | StiContainer | ||
selectComponent(component:StiComponent):void Selects the specified component in the container. | StiContainer | ||
selectInRectangle(rect:StiRectangle):void Selects all objects in the container which intersect with the specified rectangle. | StiContainer | ||
selectInRectangleCheckBands(rect:StiRectangle):void | StiContainer | ||
sendToBack():void Sends to back objects of the list in the container. | StiContainer | ||
serializeDocument():XMLNode | StiContainer | ||
Sets StiBorder from all selected objects in the container. | StiContainer | ||
setCenterHorizontally():void Centers horizontally all selected objects. | StiContainer | ||
setCenterVertically():void 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 | ||
![]() | setPaintRectangle(rect:StiRectangle):void Internal use only. | StiComponent | |
setParentStylesToChilds(style:StiBaseStyle = null):void | StiContainer | ||
![]() | setReportVariables():void | StiComponent | |
sortByPriority():void | StiContainer | ||
![]() | toString():String
Returns an Alias of the report or the Name of the report. | StiComponent | |
![]() | unPrepare():void Очищает компонент после рендеринга. | StiComponent |
Method | Defined By | ||
---|---|---|---|
![]() | allowPrintOn():Boolean | StiComponent | |
checkBlockedException(propertyName:String):void | StiContainer | ||
![]() | setDirectDisplayRectangle(rect:StiRectangle):void | StiComponent |
Constant | Defined By | ||
---|---|---|---|
PropertyBlocked : Object [static] | StiContainer | ||
![]() | PropertyComponentStyle : Object [static] | StiComponent | |
![]() | PropertyDelimiterComponent : Object [static] | StiComponent | |
![]() | PropertyDockable : Object [static] | StiComponent | |
![]() | PropertyInherited : Object [static] | StiComponent | |
![]() | PropertyLinked : Object [static] | StiComponent | |
![]() | PropertyLocked : Object [static] | StiComponent | |
![]() | PropertyRenderedCount : Object [static] | StiComponent | |
![]() | PropertyRestrictions : Object [static] | StiComponent | |
![]() | PropertySelectionTick : Object [static] | StiComponent | |
![]() | PropertyShowQuickButtons : Object [static] | StiComponent | |
![]() | PropertyUseParentStyles : Object [static] | StiComponent |
blocked | property |
blocked:Boolean
Internal use only. Это свойство используется для блокирования измнения свойств бэнда, изменение которых во время построения бэнда может исказить результат.
public function get blocked():Boolean
public function set blocked(value:Boolean):void
border | property |
border:StiBorder
Gets or sets frame of the component.
public function get border():StiBorder
public function set border(value:StiBorder):void
brush | property |
brush:StiBrush
Gets or sets a brush to fill a component.
public function get brush():StiBrush
public function set brush(value:StiBrush):void
canBreak | property |
canBreak:Boolean
Gets or sets value which indicates whether the component can or cannot break its contents on several pages.
public function get canBreak():Boolean
public function set canBreak(value:Boolean):void
collapsedValue | property |
collapsedValue:Object
Gets or sets collapsed value of the component.
public function get collapsedValue():Object
public function set collapsedValue(value:Object):void
collapsingIndex | property |
collapsingIndex:int
public function get collapsingIndex():int
public function set collapsingIndex(value:int):void
components | property |
components:StiComponentsCollection
Gets or sets a collection of components.
public function get components():StiComponentsCollection
public function set components(value:StiComponentsCollection):void
componentType | property |
componentType:int
[read-only] [override] Gets the type of processing when printing.
public function get componentType():int
containerInfoV2 | property |
containerInfoV2:StiContainerInfoV2
[read-only] public function get containerInfoV2():StiContainerInfoV2
defaultClientRectangle | property |
defaultClientRectangle:StiRectangle
[read-only] [override] Gets or sets the default client area of a component.
public function get defaultClientRectangle():StiRectangle
hasSelected | property |
hasSelected:Boolean
[read-only] Internal use only.
public function get hasSelected():Boolean
localizedName | property |
localizedName:String
[read-only] [override] Gets a localized component name.
public function get localizedName():String
parentComponentIsBand | property |
public var parentComponentIsBand:Boolean = false
Если true, то Parent компонент этого контейнера является Band.
priority | property |
priority:int
[read-only] [override] Gets a component priority.
public function get priority():int
StiContainer | () | Constructor |
public function StiContainer(rect:StiRectangle = null)
rect:StiRectangle (default = null )
|
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 |
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 |
Object |
containerToPage | () | method |
public function containerToPage(rect:StiRectangle):StiRectangle
Converts a rectangle from container coordinates into coordinates of a page.
Parameters
rect:StiRectangle |
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 |
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 |
Boolean |
getActualSize | () | method |
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.
ReturnsObject |
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 |
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 |
StiComponent |
getComponents | () | method |
public function getComponents():StiComponentsCollection
Returns the list of all components which are located in the container.
ReturnsStiComponentsCollection |
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 |
StiContainer |
getDockableComponent | () | method |
public function getDockableComponent():StiComponent
Returns the first docked and selected component.
ReturnsStiComponent |
getFirstSelectableComponent | () | method |
public function getFirstSelectableComponent():StiComponent
Returns the first selected component.
ReturnsStiComponent |
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 )
|
StiComponentsCollection |
getLink | () | method |
public function getLink():Object
Returns linked of the object being met first. Scans all selected objects in the container.
ReturnsObject |
getLock | () | method |
public function getLock():Object
Returns lock of the object being met first. Scans all selected objects in the container.
ReturnsObject — Lock
|
getSelectedComponents | () | method |
public function getSelectedComponents():StiComponentsCollection
Returns the array of the selected components.
ReturnsStiComponentsCollection |
getSelectedComponentsWithChilds | () | method |
public function getSelectedComponentsWithChilds():StiComponentsCollection
Returns the array of the selected objects including child of the selected objects.
ReturnsStiComponentsCollection |
getSelectedRectangle | () | method |
public function getSelectedRectangle():StiRectangle
Returns the rectangle that includes all selected objects in the container. The rectangle is represented in page coordinates.
ReturnsStiRectangle |
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
ReturnsObject |
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 |
StiRectangle |
pageToContainerP | () | method |
public function pageToContainerP(point:StiPoint):StiPoint
Converts a point from coordinates of a page into container coordinates.
Parameters
point:StiPoint |
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 |
sendToBack | () | method |
public function sendToBack():void
Sends to back objects of the list in the container.
serializeDocument | () | method |
public function serializeDocument():XMLNode
ReturnsXMLNode |
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
PropertyBlocked | Constant |
protected static const PropertyBlocked:Object