NAME
Solstice::Model::List - Superclass for classes that need to be both a List and a Model.
SYNOPSIS
use Solstice::Model::List;;
my $model = Solstice::Model::List->new();DESCRIPTION
Export
None by default.
Methods
- new ()
-
Creates and returns an empty Solstice::Model::List object.
- clear()
-
Removes all entries from the List object.
- reverse()
-
Reverse the order of the entries in the List.
- push($element)
-
Adds an element to the end of the List.
- pop()
-
Remove the last element in the List and return it.
- unshift($element)
-
Adds an element to the front of the List.
- shift()
-
Remove the first element in the List and return it.
- add ([$index,] $element)
-
Adds an element to the List. If no index is given it will be added to the end of the List, otherwise it will be placed at the index given, and the other elements will be shifted out of the way. Passing $index equal to the list size is also permissible. It is 0 indexed.
- addList($list)
- replace($index, $element)
-
Replace an element in the List. It is 0 indexed. If successful, the replaced element is returned.
- move ($oldindex, $newindex)
-
This will move an element from one position in the List to another. It is 0 indexed. Note: This will not reset any iterators, so there may be some confusion if you iterate over a List you are still manipulating.
- onMove
- remove ($index)
-
This will remove an element from the List, at the index given. It is 0 indexed. If successful, the removed element is returned.
- onRemove
-
This is an empty method meant for overriding by subclasses
Private Methods
AUTHOR
Catalyst Research & Development Group, <catalyst@u.washington.edu>
VERSION
$Revision: 83 $
COPYRIGHT
Copyright 1998-2007 Office of Learning Technologies, University of Washington
Licensed under the Educational Community License, Version 1.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at: http://www.opensource.org/licenses/ecl1.php
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.