1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one 3 * or more contributor license agreements. See the NOTICE file 4 * distributed with this work for additional information 5 * regarding copyright ownership. The ASF licenses this file 6 * to you under the Apache License, Version 2.0 (the 7 * "License"); you may not use this file except in compliance 8 * with the License. You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, 13 * software distributed under the License is distributed on an 14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 * KIND, either express or implied. See the License for the 16 * specific language governing permissions and limitations 17 * under the License. 18 */ 19 20 package org.apache.myfaces.custom.tree2; 21 22 public interface TreeWalker 23 { 24 /** 25 * Getter for the check state property. Indicates whether or not the TreeWalker 26 * should navigate over nodes that are not currently expanded. 27 * 28 * @return boolean 29 */ 30 public boolean isCheckState(); 31 32 /** 33 * Setter for the check state property. Indicates whether or not the TreeWalker 34 * should navigate over nodes that are not currently expanded. 35 * 36 * @param checkState boolean 37 */ 38 public void setCheckState(boolean checkState); 39 40 /** 41 * Walk the tree and set the current node to the next node. 42 * @return boolean whether or not there was another node to walk 43 */ 44 public boolean next(); 45 46 /** 47 * Returns the id of the root node. 48 * @return String 49 */ 50 public String getRootNodeId(); 51 52 /** 53 * This method allows the renderer to pass a reference to the tree object. With this 54 * reference the TreeWalker can set the current node as its walking the tree. 55 * 56 * @param tree Tree 57 */ 58 public void setTree(Tree tree); 59 60 /** 61 * Reset the walker so the tree can be walked again starting from the root. 62 */ 63 public void reset(); 64 }