| Package | com.degrafa.core.collections |
| Class | public class DegrafaCursor |
| Subclasses | CommandCursor |
| Property | Defined by | ||
|---|---|---|---|
| afterLast : Boolean [read-only]
Checks whether or not the cursor is after the last item.
| DegrafaCursor | ||
| beforeFirst : Boolean [read-only]
Checks whether or not the cursor is before the first item.
| DegrafaCursor | ||
| current : * [read-only]
Returns the Object at the currentIndex.
| DegrafaCursor | ||
| currentIndex : int
The value representing the current location of the cursor.
| DegrafaCursor | ||
| nextObject : * [read-only]
Gets the Object after the currentIndex
| DegrafaCursor | ||
| previousObject : * [read-only]
Gets the Object before the currentIndex
| DegrafaCursor | ||
| source : Array | DegrafaCursor | ||
| Method | Defined by | ||
|---|---|---|---|
|
DegrafaCursor(source:Array)
| DegrafaCursor | ||
|
insert(value:*):void
Inserts a Object into the array at the currentIndex.
| DegrafaCursor | ||
|
moveFirst():void
Moves cursor to the front.
| DegrafaCursor | ||
|
moveLast():void
Moves cursor to the end.
| DegrafaCursor | ||
|
moveNext():Boolean
Moves the cursor up one item in the currentIndex unless it is at the end.
| DegrafaCursor | ||
|
movePrevious():Boolean
Moves the cursor down one item in the currentIndex unless it is at the beginning.
| DegrafaCursor | ||
|
remove():*
Removes a Object from the array at the currentIndex.
| DegrafaCursor | ||
|
seek(bookmark:CursorBookmark, offset:int = 0):void
Moves the currentIndex using the bookmark and offset.
| DegrafaCursor | ||
| Constant | Defined by | ||
|---|---|---|---|
| AFTER_LAST_INDEX : int = -2 [static]
| DegrafaCursor | ||
| BEFORE_FIRST_INDEX : int = -1 [static]
| DegrafaCursor | ||
| afterLast | property |
afterLast:Boolean [read-only]Checks whether or not the cursor is after the last item.
Implementation public function get afterLast():Boolean
| beforeFirst | property |
beforeFirst:Boolean [read-only]Checks whether or not the cursor is before the first item.
Implementation public function get beforeFirst():Boolean
| current | property |
current:* [read-only]Returns the Object at the currentIndex. If the currentIndex is before the first index, a null value is returned;
Implementation public function get current():*
| currentIndex | property |
public var currentIndex:intThe value representing the current location of the cursor.
| nextObject | property |
nextObject:* [read-only]Gets the Object after the currentIndex
Implementation public function get nextObject():*
| previousObject | property |
previousObject:* [read-only]Gets the Object before the currentIndex
Implementation public function get previousObject():*
| source | property |
public var source:Array
| DegrafaCursor | () | constructor |
public function DegrafaCursor(source:Array)Parameters
source:Array — A reference to the enclosed Array.
|
| insert | () | method |
public function insert(value:*):voidInserts a Object into the array at the currentIndex.
Parametersvalue:* — The Object to be inserted into the array.
|
| moveFirst | () | method |
public function moveFirst():voidMoves cursor to the front.
| moveLast | () | method |
public function moveLast():voidMoves cursor to the end.
| moveNext | () | method |
public function moveNext():BooleanMoves the cursor up one item in the currentIndex unless it is at the end.
ReturnsBoolean — Boolean value of whether or not the cursor is at the end of the array.
|
| movePrevious | () | method |
public function movePrevious():BooleanMoves the cursor down one item in the currentIndex unless it is at the beginning.
ReturnsBoolean — Boolean value of whether or not the cursor is at the beginning of the array.
|
| remove | () | method |
public function remove():*Removes a Object from the array at the currentIndex.
Returns* — The Object removed from the array.
|
| seek | () | method |
public function seek(bookmark:CursorBookmark, offset:int = 0):voidMoves the currentIndex using the bookmark and offset.
Parametersbookmark:CursorBookmark — CursorBookmark used to assist the seek. The enumeration values are FIRST, CURRENT, LAST.
|
|
offset:int (default = 0) |
| AFTER_LAST_INDEX | constant |
protected static const AFTER_LAST_INDEX:int = -2
| BEFORE_FIRST_INDEX | constant |
protected static const BEFORE_FIRST_INDEX:int = -1