KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > pde > internal > core > icheatsheet > simple > ISimpleCSItem


1 /*******************************************************************************
2  * Copyright (c) 2006 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11
12 package org.eclipse.pde.internal.core.icheatsheet.simple;
13
14 /**
15  * ISimpleCSItem
16  *
17  */
18 public interface ISimpleCSItem extends ISimpleCSObject, ISimpleCSHelpObject, ISimpleCSRun {
19
20     /**
21      * Element: description
22      * @return
23      */
24     public ISimpleCSDescription getDescription();
25     
26     /**
27      * Element: description
28      * @param description
29      */
30     public void setDescription(ISimpleCSDescription description);
31     
32     /**
33      * Attribute: title
34      * @return
35      */
36     public String JavaDoc getTitle();
37     
38     /**
39      * Attribute: title
40      * @param title
41      */
42     public void setTitle(String JavaDoc title);
43     
44     /**
45      * Attribute: dialog
46      * @return
47      */
48     public boolean getDialog();
49     
50     /**
51      * Attribute: dialog
52      * @param dialog
53      */
54     public void setDialog(boolean dialog);
55     
56     /**
57      * Attribute: skip
58      * @return
59      */
60     public boolean getSkip();
61     
62     /**
63      * Attribute: skip
64      * @param skip
65      */
66     public void setSkip(boolean skip);
67
68     /**
69      * Elements: subitem, repeated-subitem, conditional-subitem
70      * @return
71      */
72     public ISimpleCSSubItemObject[] getSubItems();
73     
74     /**
75      * Element: subitem, repeated-subitem, conditional-subitem
76      * @param subitem
77      */
78     public void addSubItem(ISimpleCSSubItemObject subitem);
79     
80     /**
81      * Element: subitem, repeated-subitem, conditional-subitem
82      * @param index
83      * @param subitem
84      */
85     public void addSubItem(int index, ISimpleCSSubItemObject subitem);
86     
87     /**
88      * Element: subitem, repeated-subitem, conditional-subitem
89      * @param subitem
90      */
91     public void removeSubItem(ISimpleCSSubItemObject subitem);
92     
93     /**
94      * Element: subitem, repeated-subitem, conditional-subitem
95      * @param index
96      */
97     public void removeSubItem(int index);
98
99     /**
100      * Element: subitem, repeated-subitem, conditional-subitem
101      * @param subitem
102      * @param newRelativeIndex
103      */
104     public void moveSubItem(ISimpleCSSubItemObject subitem,
105             int newRelativeIndex);
106     
107     /**
108      * Element: onCompletion
109      * @return
110      */
111     public ISimpleCSOnCompletion getOnCompletion();
112     
113     /**
114      * Element: onCompletion
115      * @param onCompletion
116      */
117     public void setOnCompletion(ISimpleCSOnCompletion onCompletion);
118     
119     /**
120      * Element: subitem, repeated-subitem, conditional-subitem
121      * @param subitem
122      * @return
123      */
124     public boolean isFirstSubItem(ISimpleCSSubItemObject subitem);
125
126     /**
127      * Element: subitem, repeated-subitem, conditional-subitem
128      * @param subitem
129      * @return
130      */
131     public boolean isLastSubItem(ISimpleCSSubItemObject subitem);
132     
133     /**
134      * Element: subitem, repeated-subitem, conditional-subitem
135      * @param subitem
136      * @return
137      */
138     public int indexOfSubItem(ISimpleCSSubItemObject subitem);
139     
140     /**
141      * Element: subitem, repeated-subitem, conditional-subitem
142      * @return
143      */
144     public int getSubItemCount();
145
146     /**
147      * Element: subitem, repeated-subitem, conditional-subitem
148      * @return
149      */
150     public boolean hasSubItems();
151     
152     /**
153      * Element: subitem, repeated-subitem, conditional-subitem
154      * @param subitem
155      * @return
156      */
157     public ISimpleCSSubItemObject getNextSibling(ISimpleCSSubItemObject subitem);
158     
159     /**
160      * Element: subitem, repeated-subitem, conditional-subitem
161      * @param subitem
162      * @return
163      */
164     public ISimpleCSSubItemObject getPreviousSibling(ISimpleCSSubItemObject subitem);
165
166 }
167
Popular Tags