| Package | com.degrafa.core.collections |
| Class | public class StrokeCollection |
| Inheritance | StrokeCollection  DegrafaCollection DegrafaObject |
| Method | Defined by | ||
|---|---|---|---|
|
StrokeCollection(array:Array = null, suppressEvents:Boolean = false)
Constructor.
| StrokeCollection | ||
 |
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = true):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
| DegrafaObject | |
|
Adds a IGraphicsStroke item to the collection.
| StrokeCollection | ||
|
Adds a IGraphicsStroke item to this collection at the specified index.
| StrokeCollection | ||
|
Adds a series of IGraphicsStroke objects to this collection.
| StrokeCollection | ||
|
addListener(value:*):void
Addes a property change event listener and a parent reference to the passed object.
| DegrafaCollection | |
|
addListeners():void
Addes a property change event listener and a parent reference to each item in the collection.
| DegrafaCollection | |
|
concat(... args):Array
Concatenates the elements specified in the parameters with the elements in an array and creates a new array.
| DegrafaCollection | |
|
dispatchEvent(evt:Event):Boolean
Dispatches an event into the event flow.
| DegrafaObject | |
|
dispatchPropertyChange(bubbles:Boolean = false, property:Object = null, oldValue:Object = null, newValue:Object = null, source:Object = null):Boolean
Dispatches an property change event into the event flow.
| DegrafaObject | |
|
every(callback:Function, thisObject:* = null):Boolean
Executes a test function on each item in the array until an item is reached that returns false for the specified function.
| DegrafaCollection | |
|
filter(callback:Function, thisObject:* = null):Array
Executes a test function on each item in the array and constructs a new array for all items that return true for the specified function.
| DegrafaCollection | |
|
forEach(callback:Function, thisObject:* = null):void
Executes a function on each item in the array.
| DegrafaCollection | |
|
getItemAt(index:Number):IGraphicsStroke
Retrieve a IGraphicsStroke item from the collection based on the index value
requested.
| StrokeCollection | ||
|
getItemIndex(value:IGraphicsStroke):int
Retrieve a IGraphicsStroke item from the collection based on the object value.
| StrokeCollection | ||
|
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
| DegrafaObject | |
|
indexOf(searchElement:*, fromIndex:int = 0):int
Searches for an item in an array by using strict equality (===) and returns the index position of the item.
| DegrafaCollection | |
|
initChange(property:String, oldValue:Object, newValue:Object, source:Object):void
Helper function for dispatching property changes
| DegrafaObject | |
|
initialized(document:Object, id:String):void
Called after the implementing object has been created and all component properties specified on the MXML tag have been initialized.
| DegrafaObject | |
|
join(sep:*):String
Converts the elements in an array to strings, inserts the specified separator between the elements, concatenates them, and returns the resulting string.
| DegrafaCollection | |
|
lastIndexOf(searchElement:*, fromIndex:int = 0x7fffffff):int
Searches for an item in an array, working backward from the last item, and returns the index position of the matching item using strict equality (===).
| DegrafaCollection | |
|
map(callback:Function, thisObject:* = null):Array
Executes a function on each item in an array, and constructs a new array of items corresponding to the results of the function on each item in the original array.
| DegrafaCollection | |
|
pop():*
Removes the last element from an array and returns the value of that element.
| DegrafaCollection | |
|
propertyChangeHandler(event:PropertyChangeEvent):void
Property change event handler for this collection.
| DegrafaCollection | |
|
push(... args):uint
Adds one or more elements to the end of an array and returns the new length of the array.
| DegrafaCollection | |
|
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
| DegrafaObject | |
|
Removes an IGraphicsStroke item from the collection.
| StrokeCollection | ||
|
removeItemAt(index:Number):IGraphicsStroke
Removes a IGraphicsStroke object from this collection at the specified index.
| StrokeCollection | ||
|
removeListener(value:*):void
Removes the property change event listener and parent reference from the passed object.
| DegrafaCollection | |
|
removeListeners():void
Removes the property change event listener and parent reference from each item in the collection.
| DegrafaCollection | |
|
reverse():Array
Reverses the array in place.
| DegrafaCollection | |
|
setItemIndex(value:IGraphicsStroke, newIndex:Number):Boolean
Change the index of the IGraphicsStroke object within this collection.
| StrokeCollection | ||
|
shift():*
Removes the first element from an array and returns that element.
| DegrafaCollection | |
|
slice(startIndex:int = 0, endIndex:int = 16777215):Array
Returns a new array that consists of a range of elements from the original array, without modifying the original array.
| DegrafaCollection | |
|
some(callback:Function, thisObject:* = null):Boolean
Executes a test function on each item in the array until an item is reached that returns true.
| DegrafaCollection | |
|
sort(... args):Array
Sorts the elements in an array.
| DegrafaCollection | |
|
sortOn(fieldName:Object, options:Object = null):Array
Sorts the elements in an array according to one or more fields in the array.
| DegrafaCollection | |
|
splice(startIndex:int, deleteCount:uint, ... values):Array
Adds elements to and removes elements from an array.
| DegrafaCollection | |
|
unshift(... args):uint
Adds one or more elements to the beginning of an array and returns the new length of the array.
| DegrafaCollection | |
|
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
| DegrafaObject | |
| StrokeCollection | () | constructor |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic function StrokeCollection(array:Array = null, suppressEvents:Boolean = false)Constructor.
The stroke collection constructor accepts 2 optional arguments that specify the strokes to be added and a event operation flag.
Parametersarray:Array (default = null) |
|
suppressEvents:Boolean (default = false) |
| addItem | () | method |
public function addItem(value:IGraphicsStroke):IGraphicsStrokeAdds a IGraphicsStroke item to the collection.
Parametersvalue:IGraphicsStroke — The IGraphicsStroke object to be added.
|
IGraphicsStroke —
The IGraphicsStroke object that was added.
|
| addItemAt | () | method |
public function addItemAt(value:IGraphicsStroke, index:Number):IGraphicsStrokeAdds a IGraphicsStroke item to this collection at the specified index.
Parametersvalue:IGraphicsStroke — The IGraphicsStroke object that is to be added.
|
|
index:Number — The position in the collection at which to add the IGraphicsStroke object.
|
IGraphicsStroke —
The IGraphicsStroke object that was added.
|
| addItems | () | method |
public function addItems(value:StrokeCollection):StrokeCollectionAdds a series of IGraphicsStroke objects to this collection.
Parametersvalue:StrokeCollection — The collection to be added to this IGraphicsStroke collection.
|
StrokeCollection —
The resulting StrokeCollection after the objects are added.
|
| getItemAt | () | method |
public function getItemAt(index:Number):IGraphicsStrokeRetrieve a IGraphicsStroke item from the collection based on the index value requested.
Parametersindex:Number — The collection index of the IGraphicsStroke object to retrieve.
|
IGraphicsStroke —
The IGraphicsStroke object that was requested if it exists.
|
| getItemIndex | () | method |
public function getItemIndex(value:IGraphicsStroke):intRetrieve a IGraphicsStroke item from the collection based on the object value.
Parametersvalue:IGraphicsStroke — The IGraphicsStroke object for which the index is to be retrieved.
|
int — The IGraphicsStroke index value that was requested if it exists.
|
| removeItem | () | method |
public function removeItem(value:IGraphicsStroke):IGraphicsStrokeRemoves an IGraphicsStroke item from the collection.
Parametersvalue:IGraphicsStroke — The IGraphicsStroke object to be removed.
|
IGraphicsStroke —
The IGraphicsStroke object that was removed.
|
| removeItemAt | () | method |
public function removeItemAt(index:Number):IGraphicsStrokeRemoves a IGraphicsStroke object from this collection at the specified index.
Parametersindex:Number — The index of the IGraphicsStroke object to remove.
|
IGraphicsStroke —
The IGraphicsStroke object that was removed.
|
| setItemIndex | () | method |
public function setItemIndex(value:IGraphicsStroke, newIndex:Number):BooleanChange the index of the IGraphicsStroke object within this collection.
Parametersvalue:IGraphicsStroke — The IGraphicsStroke object that is to be repositioned.
|
|
newIndex:Number — The position at which to place the IGraphicsStroke object within the collection.
|
Boolean — True if the operation is successful False if unsuccessful.
|