KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > columba > core > filter > IFilterList


1 package org.columba.core.filter;
2
3 public interface IFilterList {
4
5   /** The name of this object when stored in a XML document. */
6   public static final String JavaDoc XML_NAME = "filterlist";
7
8   /**
9    * Adds the filter to this list.
10    *
11    * @param f
12    * the filter.
13    */
14   void add(IFilter f);
15
16   /**
17    * Adds all filters in the supplied list to this filter list.
18    *
19    * @param list
20    * a list containing other filters to add to this list.
21    */
22   void addAll(IFilterList list);
23
24   /**
25    * Remove the <code>Filter</code> from the list.
26    *
27    * @param f
28    * the filter to remove.
29    */
30   void remove(IFilter f);
31
32   /**
33    * Inserts the filter into the specified index in the list.
34    *
35    * @param filter
36    * filter to add.
37    * @param index
38    * the index where to insert the filter.
39    */
40   void insert(IFilter filter, int index);
41
42   /**
43    * Moves the specified filter up in the list.
44    *
45    * @param filter
46    * the filter to move up.
47    */
48   void moveUp(IFilter filter);
49
50   /**
51    * Moves the specified filter down in the list.
52    *
53    * @param filter
54    * the filter to move down.
55    */
56   void moveDown(IFilter filter);
57
58   /**
59    * Moves the specified filter a number of positions in the list.
60    *
61    * @param filter
62    * the filter to move.
63    * @param nrOfPositions
64    * the number of positions to move in the list, can be negative.
65    */
66   void move(IFilter filter, int nrOfPositions);
67
68   /**
69    * Moves the filter at the specified index a number of positions in the
70    * list.
71    *
72    * @param filterIndex
73    * the filters index.
74    * @param nrOfPositions
75    * the number of positions to move in the list, can be negative.
76    */
77   void move(int filterIndex, int nrOfPositions);
78
79   /**
80    * Returns the index in this list of the first occurrence of the specified
81    * filter, or -1 if this list does not contain this element.
82    *
83    * @param filter
84    * filter to search for.
85    * @return the index in this list of the first occurrence of the specified
86    * filter, or -1 if this list does not contain this element.
87    */
88   int indexOf(IFilter filter);
89
90   /**
91    * Returns the number of filters in this list.
92    *
93    * @return the number of filters in this list.
94    */
95   int count();
96
97   /**
98    * Returns the filter at the specified position in the list.
99    *
100    * @param index
101    * the index
102    * @return a Filter
103    */
104   IFilter get(int index);
105
106   /**
107    * Removes the filter at the specified list index.
108    *
109    * @param index
110    * the index of the filter to remove from this list.
111    */
112   void remove(int index);
113
114 }
Popular Tags