| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| BreadCrumbs |
|
| 1.0;1 |
| 1 | /* | |
| 2 | * Copyright 2007 The Kuali Foundation Licensed under the Educational Community | |
| 3 | * License, Version 1.0 (the "License"); you may not use this file except in | |
| 4 | * compliance with the License. You may obtain a copy of the License at | |
| 5 | * http://www.opensource.org/licenses/ecl1.php Unless required by applicable law | |
| 6 | * or agreed to in writing, software distributed under the License is | |
| 7 | * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
| 8 | * KIND, either express or implied. See the License for the specific language | |
| 9 | * governing permissions and limitations under the License. | |
| 10 | */ | |
| 11 | package org.kuali.rice.kns.uif.widget; | |
| 12 | ||
| 13 | import java.util.List; | |
| 14 | ||
| 15 | import org.kuali.rice.kns.uif.history.HistoryEntry; | |
| 16 | ||
| 17 | /** | |
| 18 | * The breadcrumb widget contains various settings for setting up | |
| 19 | * Breadcrumb/History support on the view. | |
| 20 | * | |
| 21 | * @author Kuali Rice Team (rice.collab@kuali.org) | |
| 22 | */ | |
| 23 | 0 | public class BreadCrumbs extends WidgetBase { |
| 24 | private static final long serialVersionUID = -2864287914665842251L; | |
| 25 | ||
| 26 | private boolean displayHomewardPath; | |
| 27 | private boolean displayPassedHistory; | |
| 28 | private boolean displayBreadcrumbsWhenOne; | |
| 29 | private List<HistoryEntry> homewardPathList; | |
| 30 | ||
| 31 | /** | |
| 32 | * Determines if the homewardPath is to be displayed. Even when this is | |
| 33 | * setting is on the code may determine to turn off homewardPath display | |
| 34 | * based on user interation and ui elements being displayed (ie lightbox) | |
| 35 | * | |
| 36 | * @return the displayHomewardPath | |
| 37 | */ | |
| 38 | public boolean isDisplayHomewardPath() { | |
| 39 | 0 | return this.displayHomewardPath; |
| 40 | } | |
| 41 | ||
| 42 | /** | |
| 43 | * @param displayHomewardPath | |
| 44 | * the displayHomewardPath to set | |
| 45 | */ | |
| 46 | public void setDisplayHomewardPath(boolean displayHomewardPath) { | |
| 47 | 0 | this.displayHomewardPath = displayHomewardPath; |
| 48 | 0 | } |
| 49 | ||
| 50 | /** | |
| 51 | * Determines if the passedHistory is to be displayed. In most cases this | |
| 52 | * should not be set through the xml as this is toggled off and on through | |
| 53 | * code during different ui procedures. | |
| 54 | * | |
| 55 | * @return the displayPassedHistory | |
| 56 | */ | |
| 57 | public boolean isDisplayPassedHistory() { | |
| 58 | 0 | return this.displayPassedHistory; |
| 59 | } | |
| 60 | ||
| 61 | /** | |
| 62 | * @param displayPassedHistory | |
| 63 | * the displayPassedHistory to set | |
| 64 | */ | |
| 65 | public void setDisplayPassedHistory(boolean displayPassedHistory) { | |
| 66 | 0 | this.displayPassedHistory = displayPassedHistory; |
| 67 | 0 | } |
| 68 | ||
| 69 | /** | |
| 70 | * The homewardPath to be displayed on this representative of the logical | |
| 71 | * "location" of the view within the site hierarchy, can be set to anything | |
| 72 | * desired. | |
| 73 | * | |
| 74 | * @return the homewardPathList | |
| 75 | */ | |
| 76 | public List<HistoryEntry> getHomewardPathList() { | |
| 77 | 0 | return this.homewardPathList; |
| 78 | } | |
| 79 | ||
| 80 | /** | |
| 81 | * @param homewardPathList | |
| 82 | * the homewardPathList to set | |
| 83 | */ | |
| 84 | public void setHomewardPathList(List<HistoryEntry> homewardPathList) { | |
| 85 | 0 | this.homewardPathList = homewardPathList; |
| 86 | 0 | } |
| 87 | ||
| 88 | /** | |
| 89 | * If true, breadcrumbs will not be displayed if only one breadcrumb is | |
| 90 | * going to be shown, this improves visual clarity of the page | |
| 91 | * | |
| 92 | * @return the displayBreadcrumbsWhenOne | |
| 93 | */ | |
| 94 | public boolean isDisplayBreadcrumbsWhenOne() { | |
| 95 | 0 | return this.displayBreadcrumbsWhenOne; |
| 96 | } | |
| 97 | ||
| 98 | /** | |
| 99 | * @param displayBreadcrumbsWhenOne | |
| 100 | * the displayBreadcrumbsWhenOne to set | |
| 101 | */ | |
| 102 | public void setDisplayBreadcrumbsWhenOne(boolean displayBreadcrumbsWhenOne) { | |
| 103 | 0 | this.displayBreadcrumbsWhenOne = displayBreadcrumbsWhenOne; |
| 104 | 0 | } |
| 105 | ||
| 106 | } |