TraverseTreeOptions

/*
Copyright 2005 by the authors of asapframework

Licensed under the Apache License, Version 2.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.apache.org/licenses/LICENSE-2.0

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.
*/

/**
Tree traverse options used by {@link TraverseTreeEnumerator}.
@author Arthur Clemens
@version 20 July 2005
@use
In the following example the enumerator traverse options are read from checkboxes:
<code>
var traverseOptions:Number = TraverseTreeOptions.NONE;
var shouldTraverse:Boolean = traverse_cb.value;
if (shouldTraverse) {
    traverseOptions |= TraverseTreeOptions.TRAVERSE_CHILDREN;
}
var shouldLoop:Boolean = loop_cb.value;
if (shouldLoop) {
    traverseOptions |= TraverseTreeOptions.LOOP;
}
var shouldSkipRoot:Boolean = skiproot_cb.value;
if (shouldSkipRoot) {
    traverseOptions |= TraverseTreeOptions.SKIP_ROOT;
}
</code>
*/

class data.tree.TraverseTreeOptions {

    public static var NONE:Number =                    (1<<0); /**< The enumerator does nothing. */
    public static var TRAVERSE_CHILDREN:Number =    (1<<1); /**< The enumerator traverses all children. */
    public static var LOOP:Number =                 (1<<2); /**< The enumerator loops to the first node. */
    public static var SKIP_ROOT:Number =             (1<<3); /**< The enumerator skips the root node and stops at the first node after the root. */
}