View Javadoc

1   /***
2    * ModifiableReport.java
3    *
4    * This file is part of the creme library.
5    * The creme library intends to ease the development effort of large
6    * applications by providing easy to use support classes.
7    *
8    * Copyright (C) 2002 Denis Bregeon
9    *
10   * This library is free software; you can redistribute it and/or
11   * modify it under the terms of the GNU Lesser General Public
12   * License as published by the Free Software Foundation; either
13   * version 2.1 of the License, or (at your option) any later version.
14   *
15   * This library is distributed in the hope that it will be useful,
16   * but WITHOUT ANY WARRANTY; without even the implied warranty of
17   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18   * Lesser General Public License for more details.
19   *
20   * You should have received a copy of the GNU Lesser General Public
21   * License along with this library; if not, write to the Free Software
22   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
23   *
24   * contact information: dbregeon@sourceforge.net
25   */
26  package org.jcreme.reporting;
27  
28  /***
29   * This interface extends the Report framework. It enables to change the values
30   * in the report.
31   * 
32   * @author $Author: dbregeon $
33   * @version $Revision: 1.2 $
34   *  
35   */
36  public interface ModifiableReport extends Report {
37      /***
38       * This method enables to change the value at the given row and column for
39       * this report.
40       * 
41       * @param value
42       *            the value to put in the report for the particular row and the
43       *            particular column.
44       * @param row
45       *            the row for which we want to change the value.
46       * @param column
47       *            the column for which we want to change the value.
48       * @throws IllegalArgumentException
49       *             if the value is not valid in the report at this column and
50       *             row.
51       */
52      void setValueAt(Object value, int row, int column)
53              throws IllegalArgumentException;
54  
55      /***
56       * This method enables to determine if a value is modifiable in the Report.
57       * 
58       * @param row
59       *            the row for which we want to change the value.
60       * @param column
61       *            the column for which we want to change the value.
62       * @return true is the value can be modified through setValueAt. False
63       *         otherwise.
64       */
65      boolean isEditable(int row, int column);
66  }