01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/osp/tags/sakai_2-4-1/wizard/tool/src/java/org/theospi/portfolio/wizard/tool/DecoratedListInterface.java $
03: * $Id: DecoratedListInterface.java 10835 2006-06-17 03:25:03Z lance@indiana.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2005, 2006 The Sakai Foundation.
07: *
08: * Licensed under the Educational Community License, Version 1.0 (the "License");
09: * you may not use this file except in compliance with the License.
10: * You may obtain a copy of the License at
11: *
12: * http://www.opensource.org/licenses/ecl1.php
13: *
14: * Unless required by applicable law or agreed to in writing, software
15: * distributed under the License is distributed on an "AS IS" BASIS,
16: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17: * See the License for the specific language governing permissions and
18: * limitations under the License.
19: *
20: **********************************************************************************/package org.theospi.portfolio.wizard.tool;
21:
22: /**
23: * This class is for defining the methods used to display the pages and categories
24: * We also want to show the wizard itself in the case of the hierachical wizard
25: * @author andersjb
26: *
27: */
28: public interface DecoratedListInterface {
29:
30: /**
31: * tells the parent category of the instance
32: * @return DecoratedCategory
33: */
34: public DecoratedCategory getCategory();
35:
36: /**
37: * used to indent the title on the cat/page screen
38: * @return String
39: */
40: public String getIndentString();
41:
42: /**
43: * gets the title of the page/category list item
44: * @return String
45: */
46: public String getTitle();
47:
48: /**
49: * can this list element move?
50: * @return boolean
51: */
52: public boolean isMoveTarget();
53:
54: /**
55: * specifies if the instance has children
56: * @return boolean
57: */
58: public boolean getHasChildren();
59:
60: /**
61: * Tells whether this instance is the first element in the parent list
62: * @return boolean
63: */
64: public boolean isFirst();
65:
66: /**
67: * Tells whether this instance is the last element in the parent list
68: * @return boolean
69: */
70: public boolean isLast();
71:
72: /**
73: * Tells whether this instance is the wizard itself
74: * @return boolean
75: */
76: public boolean isWizard();
77: }
|