KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > jxl > biff > DisplayFormat


1 /*********************************************************************
2 *
3 * Copyright (C) 2002 Andrew Khan
4 *
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
9 *
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
14 *
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 ***************************************************************************/

19
20 package jxl.biff;
21
22 /**
23  * The interface implemented by the various number and date format styles.
24  * The methods on this interface are called internally when generating a
25  * spreadsheet
26  */

27 public interface DisplayFormat
28 {
29   /**
30    * Accessor for the index style of this format
31    *
32    * @return the index for this format
33    */

34   public int getFormatIndex();
35   /**
36    * Accessor to see whether this format has been initialized
37    *
38    * @return TRUE if initialized, FALSE otherwise
39    */

40   public boolean isInitialized();
41
42   /**
43    * Initializes this format with the specified index number
44    *
45    * @param pos the position of this format record in the workbook
46    */

47   public void initialize(int pos);
48
49   /**
50    * Accessor to determine whether or not this format is built in
51    *
52    * @return TRUE if this format is a built in format, FALSE otherwise
53    */

54   public boolean isBuiltIn();
55 }
56
Popular Tags